Class RunFunnelReportResponse.Builder (0.35.0)

public static final class RunFunnelReportResponse.Builder extends GeneratedMessageV3.Builder<RunFunnelReportResponse.Builder> implements RunFunnelReportResponseOrBuilder

The funnel report response contains two sub reports. The two sub reports are different combinations of dimensions and metrics.

Protobuf type google.analytics.data.v1alpha.RunFunnelReportResponse

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunFunnelReportResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RunFunnelReportResponse.Builder
Overrides

build()

public RunFunnelReportResponse build()
Returns
TypeDescription
RunFunnelReportResponse

buildPartial()

public RunFunnelReportResponse buildPartial()
Returns
TypeDescription
RunFunnelReportResponse

clear()

public RunFunnelReportResponse.Builder clear()
Returns
TypeDescription
RunFunnelReportResponse.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RunFunnelReportResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RunFunnelReportResponse.Builder
Overrides

clearFunnelTable()

public RunFunnelReportResponse.Builder clearFunnelTable()

The funnel table is a report with the funnel step, segment, breakdown dimension, active users, completion rate, abandonments, and abandonments rate.

The segment dimension is only present in this response if a segment was requested. The breakdown dimension is only present in this response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_table = 1;

Returns
TypeDescription
RunFunnelReportResponse.Builder

clearFunnelVisualization()

public RunFunnelReportResponse.Builder clearFunnelVisualization()

The funnel visualization is a report with the funnel step, segment, date, next action dimension, and active users.

The segment dimension is only present in this response if a segment was requested. The date dimension is only present in this response if it was requested through the TRENDED_FUNNEL funnel type. The next action dimension is only present in the response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_visualization = 2;

Returns
TypeDescription
RunFunnelReportResponse.Builder

clearKind()

public RunFunnelReportResponse.Builder clearKind()

Identifies what kind of resource this message is. This kind is always the fixed string "analyticsData#runFunnelReport". Useful to distinguish between response types in JSON.

string kind = 4;

Returns
TypeDescription
RunFunnelReportResponse.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RunFunnelReportResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
RunFunnelReportResponse.Builder
Overrides

clearPropertyQuota()

public RunFunnelReportResponse.Builder clearPropertyQuota()

This Analytics Property's quota state including this request.

.google.analytics.data.v1alpha.PropertyQuota property_quota = 3;

Returns
TypeDescription
RunFunnelReportResponse.Builder

clone()

public RunFunnelReportResponse.Builder clone()
Returns
TypeDescription
RunFunnelReportResponse.Builder
Overrides

getDefaultInstanceForType()

public RunFunnelReportResponse getDefaultInstanceForType()
Returns
TypeDescription
RunFunnelReportResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFunnelTable()

public FunnelSubReport getFunnelTable()

The funnel table is a report with the funnel step, segment, breakdown dimension, active users, completion rate, abandonments, and abandonments rate.

The segment dimension is only present in this response if a segment was requested. The breakdown dimension is only present in this response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_table = 1;

Returns
TypeDescription
FunnelSubReport

The funnelTable.

getFunnelTableBuilder()

public FunnelSubReport.Builder getFunnelTableBuilder()

The funnel table is a report with the funnel step, segment, breakdown dimension, active users, completion rate, abandonments, and abandonments rate.

The segment dimension is only present in this response if a segment was requested. The breakdown dimension is only present in this response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_table = 1;

Returns
TypeDescription
FunnelSubReport.Builder

getFunnelTableOrBuilder()

public FunnelSubReportOrBuilder getFunnelTableOrBuilder()

The funnel table is a report with the funnel step, segment, breakdown dimension, active users, completion rate, abandonments, and abandonments rate.

The segment dimension is only present in this response if a segment was requested. The breakdown dimension is only present in this response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_table = 1;

Returns
TypeDescription
FunnelSubReportOrBuilder

getFunnelVisualization()

public FunnelSubReport getFunnelVisualization()

The funnel visualization is a report with the funnel step, segment, date, next action dimension, and active users.

The segment dimension is only present in this response if a segment was requested. The date dimension is only present in this response if it was requested through the TRENDED_FUNNEL funnel type. The next action dimension is only present in the response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_visualization = 2;

Returns
TypeDescription
FunnelSubReport

The funnelVisualization.

getFunnelVisualizationBuilder()

public FunnelSubReport.Builder getFunnelVisualizationBuilder()

The funnel visualization is a report with the funnel step, segment, date, next action dimension, and active users.

The segment dimension is only present in this response if a segment was requested. The date dimension is only present in this response if it was requested through the TRENDED_FUNNEL funnel type. The next action dimension is only present in the response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_visualization = 2;

Returns
TypeDescription
FunnelSubReport.Builder

getFunnelVisualizationOrBuilder()

public FunnelSubReportOrBuilder getFunnelVisualizationOrBuilder()

The funnel visualization is a report with the funnel step, segment, date, next action dimension, and active users.

The segment dimension is only present in this response if a segment was requested. The date dimension is only present in this response if it was requested through the TRENDED_FUNNEL funnel type. The next action dimension is only present in the response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_visualization = 2;

Returns
TypeDescription
FunnelSubReportOrBuilder

getKind()

public String getKind()

Identifies what kind of resource this message is. This kind is always the fixed string "analyticsData#runFunnelReport". Useful to distinguish between response types in JSON.

string kind = 4;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

Identifies what kind of resource this message is. This kind is always the fixed string "analyticsData#runFunnelReport". Useful to distinguish between response types in JSON.

string kind = 4;

Returns
TypeDescription
ByteString

The bytes for kind.

getPropertyQuota()

public PropertyQuota getPropertyQuota()

This Analytics Property's quota state including this request.

.google.analytics.data.v1alpha.PropertyQuota property_quota = 3;

Returns
TypeDescription
PropertyQuota

The propertyQuota.

getPropertyQuotaBuilder()

public PropertyQuota.Builder getPropertyQuotaBuilder()

This Analytics Property's quota state including this request.

.google.analytics.data.v1alpha.PropertyQuota property_quota = 3;

Returns
TypeDescription
PropertyQuota.Builder

getPropertyQuotaOrBuilder()

public PropertyQuotaOrBuilder getPropertyQuotaOrBuilder()

This Analytics Property's quota state including this request.

.google.analytics.data.v1alpha.PropertyQuota property_quota = 3;

Returns
TypeDescription
PropertyQuotaOrBuilder

hasFunnelTable()

public boolean hasFunnelTable()

The funnel table is a report with the funnel step, segment, breakdown dimension, active users, completion rate, abandonments, and abandonments rate.

The segment dimension is only present in this response if a segment was requested. The breakdown dimension is only present in this response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_table = 1;

Returns
TypeDescription
boolean

Whether the funnelTable field is set.

hasFunnelVisualization()

public boolean hasFunnelVisualization()

The funnel visualization is a report with the funnel step, segment, date, next action dimension, and active users.

The segment dimension is only present in this response if a segment was requested. The date dimension is only present in this response if it was requested through the TRENDED_FUNNEL funnel type. The next action dimension is only present in the response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_visualization = 2;

Returns
TypeDescription
boolean

Whether the funnelVisualization field is set.

hasPropertyQuota()

public boolean hasPropertyQuota()

This Analytics Property's quota state including this request.

.google.analytics.data.v1alpha.PropertyQuota property_quota = 3;

Returns
TypeDescription
boolean

Whether the propertyQuota field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(RunFunnelReportResponse other)

public RunFunnelReportResponse.Builder mergeFrom(RunFunnelReportResponse other)
Parameter
NameDescription
otherRunFunnelReportResponse
Returns
TypeDescription
RunFunnelReportResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunFunnelReportResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunFunnelReportResponse.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RunFunnelReportResponse.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RunFunnelReportResponse.Builder
Overrides

mergeFunnelTable(FunnelSubReport value)

public RunFunnelReportResponse.Builder mergeFunnelTable(FunnelSubReport value)

The funnel table is a report with the funnel step, segment, breakdown dimension, active users, completion rate, abandonments, and abandonments rate.

The segment dimension is only present in this response if a segment was requested. The breakdown dimension is only present in this response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_table = 1;

Parameter
NameDescription
valueFunnelSubReport
Returns
TypeDescription
RunFunnelReportResponse.Builder

mergeFunnelVisualization(FunnelSubReport value)

public RunFunnelReportResponse.Builder mergeFunnelVisualization(FunnelSubReport value)

The funnel visualization is a report with the funnel step, segment, date, next action dimension, and active users.

The segment dimension is only present in this response if a segment was requested. The date dimension is only present in this response if it was requested through the TRENDED_FUNNEL funnel type. The next action dimension is only present in the response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_visualization = 2;

Parameter
NameDescription
valueFunnelSubReport
Returns
TypeDescription
RunFunnelReportResponse.Builder

mergePropertyQuota(PropertyQuota value)

public RunFunnelReportResponse.Builder mergePropertyQuota(PropertyQuota value)

This Analytics Property's quota state including this request.

.google.analytics.data.v1alpha.PropertyQuota property_quota = 3;

Parameter
NameDescription
valuePropertyQuota
Returns
TypeDescription
RunFunnelReportResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunFunnelReportResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RunFunnelReportResponse.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public RunFunnelReportResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RunFunnelReportResponse.Builder
Overrides

setFunnelTable(FunnelSubReport value)

public RunFunnelReportResponse.Builder setFunnelTable(FunnelSubReport value)

The funnel table is a report with the funnel step, segment, breakdown dimension, active users, completion rate, abandonments, and abandonments rate.

The segment dimension is only present in this response if a segment was requested. The breakdown dimension is only present in this response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_table = 1;

Parameter
NameDescription
valueFunnelSubReport
Returns
TypeDescription
RunFunnelReportResponse.Builder

setFunnelTable(FunnelSubReport.Builder builderForValue)

public RunFunnelReportResponse.Builder setFunnelTable(FunnelSubReport.Builder builderForValue)

The funnel table is a report with the funnel step, segment, breakdown dimension, active users, completion rate, abandonments, and abandonments rate.

The segment dimension is only present in this response if a segment was requested. The breakdown dimension is only present in this response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_table = 1;

Parameter
NameDescription
builderForValueFunnelSubReport.Builder
Returns
TypeDescription
RunFunnelReportResponse.Builder

setFunnelVisualization(FunnelSubReport value)

public RunFunnelReportResponse.Builder setFunnelVisualization(FunnelSubReport value)

The funnel visualization is a report with the funnel step, segment, date, next action dimension, and active users.

The segment dimension is only present in this response if a segment was requested. The date dimension is only present in this response if it was requested through the TRENDED_FUNNEL funnel type. The next action dimension is only present in the response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_visualization = 2;

Parameter
NameDescription
valueFunnelSubReport
Returns
TypeDescription
RunFunnelReportResponse.Builder

setFunnelVisualization(FunnelSubReport.Builder builderForValue)

public RunFunnelReportResponse.Builder setFunnelVisualization(FunnelSubReport.Builder builderForValue)

The funnel visualization is a report with the funnel step, segment, date, next action dimension, and active users.

The segment dimension is only present in this response if a segment was requested. The date dimension is only present in this response if it was requested through the TRENDED_FUNNEL funnel type. The next action dimension is only present in the response if it was requested.

.google.analytics.data.v1alpha.FunnelSubReport funnel_visualization = 2;

Parameter
NameDescription
builderForValueFunnelSubReport.Builder
Returns
TypeDescription
RunFunnelReportResponse.Builder

setKind(String value)

public RunFunnelReportResponse.Builder setKind(String value)

Identifies what kind of resource this message is. This kind is always the fixed string "analyticsData#runFunnelReport". Useful to distinguish between response types in JSON.

string kind = 4;

Parameter
NameDescription
valueString

The kind to set.

Returns
TypeDescription
RunFunnelReportResponse.Builder

This builder for chaining.

setKindBytes(ByteString value)

public RunFunnelReportResponse.Builder setKindBytes(ByteString value)

Identifies what kind of resource this message is. This kind is always the fixed string "analyticsData#runFunnelReport". Useful to distinguish between response types in JSON.

string kind = 4;

Parameter
NameDescription
valueByteString

The bytes for kind to set.

Returns
TypeDescription
RunFunnelReportResponse.Builder

This builder for chaining.

setPropertyQuota(PropertyQuota value)

public RunFunnelReportResponse.Builder setPropertyQuota(PropertyQuota value)

This Analytics Property's quota state including this request.

.google.analytics.data.v1alpha.PropertyQuota property_quota = 3;

Parameter
NameDescription
valuePropertyQuota
Returns
TypeDescription
RunFunnelReportResponse.Builder

setPropertyQuota(PropertyQuota.Builder builderForValue)

public RunFunnelReportResponse.Builder setPropertyQuota(PropertyQuota.Builder builderForValue)

This Analytics Property's quota state including this request.

.google.analytics.data.v1alpha.PropertyQuota property_quota = 3;

Parameter
NameDescription
builderForValuePropertyQuota.Builder
Returns
TypeDescription
RunFunnelReportResponse.Builder

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

public RunFunnelReportResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RunFunnelReportResponse.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RunFunnelReportResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RunFunnelReportResponse.Builder
Overrides