public static final class FunnelSubReport.Builder extends GeneratedMessageV3.Builder<FunnelSubReport.Builder> 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
public FunnelSubReport.Builder addAllDimensionHeaders(Iterable<? extends DimensionHeader> values)
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 |
values | Iterable<? extends com.google.analytics.data.v1alpha.DimensionHeader>
|
Returns
public FunnelSubReport.Builder addAllMetricHeaders(Iterable<? extends MetricHeader> values)
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 |
values | Iterable<? extends com.google.analytics.data.v1alpha.MetricHeader>
|
Returns
addAllRows(Iterable<? extends Row> values)
public FunnelSubReport.Builder addAllRows(Iterable<? extends Row> values)
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1alpha.Row rows = 3;
Parameter
Name | Description |
values | Iterable<? extends com.google.analytics.data.v1alpha.Row>
|
Returns
public FunnelSubReport.Builder addDimensionHeaders(DimensionHeader value)
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
Returns
public FunnelSubReport.Builder addDimensionHeaders(DimensionHeader.Builder builderForValue)
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
Returns
public FunnelSubReport.Builder addDimensionHeaders(int index, DimensionHeader value)
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;
Parameters
Returns
public FunnelSubReport.Builder addDimensionHeaders(int index, DimensionHeader.Builder builderForValue)
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;
Parameters
Returns
public DimensionHeader.Builder addDimensionHeadersBuilder()
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
public DimensionHeader.Builder addDimensionHeadersBuilder(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
Returns
public FunnelSubReport.Builder addMetricHeaders(MetricHeader value)
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
Returns
public FunnelSubReport.Builder addMetricHeaders(MetricHeader.Builder builderForValue)
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
Returns
public FunnelSubReport.Builder addMetricHeaders(int index, MetricHeader value)
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;
Parameters
Returns
public FunnelSubReport.Builder addMetricHeaders(int index, MetricHeader.Builder builderForValue)
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;
Parameters
Returns
public MetricHeader.Builder addMetricHeadersBuilder()
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
public MetricHeader.Builder addMetricHeadersBuilder(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
Returns
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public FunnelSubReport.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
addRows(Row value)
public FunnelSubReport.Builder addRows(Row value)
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1alpha.Row rows = 3;
Parameter
Returns
addRows(Row.Builder builderForValue)
public FunnelSubReport.Builder addRows(Row.Builder builderForValue)
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1alpha.Row rows = 3;
Parameter
Returns
addRows(int index, Row value)
public FunnelSubReport.Builder addRows(int index, Row value)
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1alpha.Row rows = 3;
Parameters
Name | Description |
index | int
|
value | Row
|
Returns
addRows(int index, Row.Builder builderForValue)
public FunnelSubReport.Builder addRows(int index, Row.Builder builderForValue)
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1alpha.Row rows = 3;
Parameters
Returns
addRowsBuilder()
public Row.Builder addRowsBuilder()
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1alpha.Row rows = 3;
Returns
addRowsBuilder(int index)
public Row.Builder addRowsBuilder(int index)
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1alpha.Row rows = 3;
Parameter
Returns
build()
public FunnelSubReport build()
Returns
buildPartial()
public FunnelSubReport buildPartial()
Returns
clear()
public FunnelSubReport.Builder clear()
Returns
Overrides
public FunnelSubReport.Builder clearDimensionHeaders()
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
clearField(Descriptors.FieldDescriptor field)
public FunnelSubReport.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
public FunnelSubReport.Builder clearMetadata()
Metadata for the funnel report.
.google.analytics.data.v1alpha.FunnelResponseMetadata metadata = 4;
Returns
public FunnelSubReport.Builder clearMetricHeaders()
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
clearOneof(Descriptors.OneofDescriptor oneof)
public FunnelSubReport.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearRows()
public FunnelSubReport.Builder clearRows()
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1alpha.Row rows = 3;
Returns
clone()
public FunnelSubReport.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public FunnelSubReport getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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
Returns
public DimensionHeader.Builder getDimensionHeadersBuilder(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
Returns
public List<DimensionHeader.Builder> getDimensionHeadersBuilderList()
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
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
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
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
Returns
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> | |
public FunnelResponseMetadata getMetadata()
Metadata for the funnel report.
.google.analytics.data.v1alpha.FunnelResponseMetadata metadata = 4;
Returns
public FunnelResponseMetadata.Builder getMetadataBuilder()
Metadata for the funnel report.
.google.analytics.data.v1alpha.FunnelResponseMetadata metadata = 4;
Returns
public FunnelResponseMetadataOrBuilder getMetadataOrBuilder()
Metadata for the funnel report.
.google.analytics.data.v1alpha.FunnelResponseMetadata metadata = 4;
Returns
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
Returns
public MetricHeader.Builder getMetricHeadersBuilder(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
Returns
public List<MetricHeader.Builder> getMetricHeadersBuilderList()
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
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
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
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
Returns
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> | |
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
Returns
getRowsBuilder(int index)
public Row.Builder getRowsBuilder(int index)
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1alpha.Row rows = 3;
Parameter
Returns
getRowsBuilderList()
public List<Row.Builder> getRowsBuilderList()
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1alpha.Row rows = 3;
Returns
getRowsCount()
public int getRowsCount()
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1alpha.Row rows = 3;
Returns
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
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
Returns
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> | |
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(FunnelSubReport other)
public FunnelSubReport.Builder mergeFrom(FunnelSubReport other)
Parameter
Returns
public FunnelSubReport.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public FunnelSubReport.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
public FunnelSubReport.Builder mergeMetadata(FunnelResponseMetadata value)
Metadata for the funnel report.
.google.analytics.data.v1alpha.FunnelResponseMetadata metadata = 4;
Parameter
Returns
mergeUnknownFields(UnknownFieldSet unknownFields)
public final FunnelSubReport.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
public FunnelSubReport.Builder removeDimensionHeaders(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
Returns
public FunnelSubReport.Builder removeMetricHeaders(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
Returns
removeRows(int index)
public FunnelSubReport.Builder removeRows(int index)
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1alpha.Row rows = 3;
Parameter
Returns
public FunnelSubReport.Builder setDimensionHeaders(int index, DimensionHeader value)
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;
Parameters
Returns
public FunnelSubReport.Builder setDimensionHeaders(int index, DimensionHeader.Builder builderForValue)
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;
Parameters
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public FunnelSubReport.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public FunnelSubReport.Builder setMetadata(FunnelResponseMetadata value)
Metadata for the funnel report.
.google.analytics.data.v1alpha.FunnelResponseMetadata metadata = 4;
Parameter
Returns
public FunnelSubReport.Builder setMetadata(FunnelResponseMetadata.Builder builderForValue)
Metadata for the funnel report.
.google.analytics.data.v1alpha.FunnelResponseMetadata metadata = 4;
Parameter
Returns
public FunnelSubReport.Builder setMetricHeaders(int index, MetricHeader value)
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;
Parameters
Returns
public FunnelSubReport.Builder setMetricHeaders(int index, MetricHeader.Builder builderForValue)
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;
Parameters
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public FunnelSubReport.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setRows(int index, Row value)
public FunnelSubReport.Builder setRows(int index, Row value)
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1alpha.Row rows = 3;
Parameters
Name | Description |
index | int
|
value | Row
|
Returns
setRows(int index, Row.Builder builderForValue)
public FunnelSubReport.Builder setRows(int index, Row.Builder builderForValue)
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1alpha.Row rows = 3;
Parameters
Returns
setUnknownFields(UnknownFieldSet unknownFields)
public final FunnelSubReport.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides