Class FunnelSubReport (0.60.0)

public final class FunnelSubReport extends GeneratedMessageV3 implements FunnelSubReportOrBuilder

Funnel sub reports contain the dimension and metric data values. For example, 12 users reached the second step of the funnel.

Protobuf type google.analytics.data.v1alpha.FunnelSubReport

Static Fields

DIMENSION_HEADERS_FIELD_NUMBER

public static final int DIMENSION_HEADERS_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

METRIC_HEADERS_FIELD_NUMBER

public static final int METRIC_HEADERS_FIELD_NUMBER
Field Value
Type Description
int

ROWS_FIELD_NUMBER

public static final int ROWS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FunnelSubReport getDefaultInstance()
Returns
Type Description
FunnelSubReport

getDescriptor()

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

newBuilder()

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

newBuilder(FunnelSubReport prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public FunnelSubReport getDefaultInstanceForType()
Returns
Type Description
FunnelSubReport

getDimensionHeaders(int index)

public DimensionHeader getDimensionHeaders(int index)

Describes dimension columns. Funnel reports always include the funnel step dimension in sub report responses. Additional dimensions like breakdowns, dates, and next actions may be present in the response if requested.

repeated .google.analytics.data.v1alpha.DimensionHeader dimension_headers = 1;

Parameter
Name Description
index int
Returns
Type Description
DimensionHeader

getDimensionHeadersCount()

public int getDimensionHeadersCount()

Describes dimension columns. Funnel reports always include the funnel step dimension in sub report responses. Additional dimensions like breakdowns, dates, and next actions may be present in the response if requested.

repeated .google.analytics.data.v1alpha.DimensionHeader dimension_headers = 1;

Returns
Type Description
int

getDimensionHeadersList()

public List<DimensionHeader> getDimensionHeadersList()

Describes dimension columns. Funnel reports always include the funnel step dimension in sub report responses. Additional dimensions like breakdowns, dates, and next actions may be present in the response if requested.

repeated .google.analytics.data.v1alpha.DimensionHeader dimension_headers = 1;

Returns
Type Description
List<DimensionHeader>

getDimensionHeadersOrBuilder(int index)

public DimensionHeaderOrBuilder getDimensionHeadersOrBuilder(int index)

Describes dimension columns. Funnel reports always include the funnel step dimension in sub report responses. Additional dimensions like breakdowns, dates, and next actions may be present in the response if requested.

repeated .google.analytics.data.v1alpha.DimensionHeader dimension_headers = 1;

Parameter
Name Description
index int
Returns
Type Description
DimensionHeaderOrBuilder

getDimensionHeadersOrBuilderList()

public List<? extends DimensionHeaderOrBuilder> getDimensionHeadersOrBuilderList()

Describes dimension columns. Funnel reports always include the funnel step dimension in sub report responses. Additional dimensions like breakdowns, dates, and next actions may be present in the response if requested.

repeated .google.analytics.data.v1alpha.DimensionHeader dimension_headers = 1;

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

getMetadata()

public FunnelResponseMetadata getMetadata()

Metadata for the funnel report.

.google.analytics.data.v1alpha.FunnelResponseMetadata metadata = 4;

Returns
Type Description
FunnelResponseMetadata

The metadata.

getMetadataOrBuilder()

public FunnelResponseMetadataOrBuilder getMetadataOrBuilder()

Metadata for the funnel report.

.google.analytics.data.v1alpha.FunnelResponseMetadata metadata = 4;

Returns
Type Description
FunnelResponseMetadataOrBuilder

getMetricHeaders(int index)

public MetricHeader getMetricHeaders(int index)

Describes metric columns. Funnel reports always include active users in sub report responses. The funnel table includes additional metrics like completion rate, abandonments, and abandonments rate.

repeated .google.analytics.data.v1alpha.MetricHeader metric_headers = 2;

Parameter
Name Description
index int
Returns
Type Description
MetricHeader

getMetricHeadersCount()

public int getMetricHeadersCount()

Describes metric columns. Funnel reports always include active users in sub report responses. The funnel table includes additional metrics like completion rate, abandonments, and abandonments rate.

repeated .google.analytics.data.v1alpha.MetricHeader metric_headers = 2;

Returns
Type Description
int

getMetricHeadersList()

public List<MetricHeader> getMetricHeadersList()

Describes metric columns. Funnel reports always include active users in sub report responses. The funnel table includes additional metrics like completion rate, abandonments, and abandonments rate.

repeated .google.analytics.data.v1alpha.MetricHeader metric_headers = 2;

Returns
Type Description
List<MetricHeader>

getMetricHeadersOrBuilder(int index)

public MetricHeaderOrBuilder getMetricHeadersOrBuilder(int index)

Describes metric columns. Funnel reports always include active users in sub report responses. The funnel table includes additional metrics like completion rate, abandonments, and abandonments rate.

repeated .google.analytics.data.v1alpha.MetricHeader metric_headers = 2;

Parameter
Name Description
index int
Returns
Type Description
MetricHeaderOrBuilder

getMetricHeadersOrBuilderList()

public List<? extends MetricHeaderOrBuilder> getMetricHeadersOrBuilderList()

Describes metric columns. Funnel reports always include active users in sub report responses. The funnel table includes additional metrics like completion rate, abandonments, and abandonments rate.

repeated .google.analytics.data.v1alpha.MetricHeader metric_headers = 2;

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

getParserForType()

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

getRows(int index)

public Row getRows(int index)

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1alpha.Row rows = 3;

Parameter
Name Description
index int
Returns
Type Description
Row

getRowsCount()

public int getRowsCount()

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1alpha.Row rows = 3;

Returns
Type Description
int

getRowsList()

public List<Row> getRowsList()

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1alpha.Row rows = 3;

Returns
Type Description
List<Row>

getRowsOrBuilder(int index)

public RowOrBuilder getRowsOrBuilder(int index)

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1alpha.Row rows = 3;

Parameter
Name Description
index int
Returns
Type Description
RowOrBuilder

getRowsOrBuilderList()

public List<? extends RowOrBuilder> getRowsOrBuilderList()

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1alpha.Row rows = 3;

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasMetadata()

public boolean hasMetadata()

Metadata for the funnel report.

.google.analytics.data.v1alpha.FunnelResponseMetadata metadata = 4;

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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