Class RunFunnelReportRequest.Builder (0.53.0)

public static final class RunFunnelReportRequest.Builder extends GeneratedMessageV3.Builder<RunFunnelReportRequest.Builder> implements RunFunnelReportRequestOrBuilder

The request for a funnel report.

Protobuf type google.analytics.data.v1alpha.RunFunnelReportRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RunFunnelReportRequest.Builder

Implements

RunFunnelReportRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllDateRanges(Iterable<? extends DateRange> values)

public RunFunnelReportRequest.Builder addAllDateRanges(Iterable<? extends DateRange> values)

Optional. Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges.

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`values`	`Iterable<? extends com.google.analytics.data.v1alpha.DateRange>`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

addAllSegments(Iterable<? extends Segment> values)

public RunFunnelReportRequest.Builder addAllSegments(Iterable<? extends Segment> values)

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`values`	`Iterable<? extends com.google.analytics.data.v1alpha.Segment>`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

addDateRanges(DateRange value)

public RunFunnelReportRequest.Builder addDateRanges(DateRange value)

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`DateRange`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

addDateRanges(DateRange.Builder builderForValue)

public RunFunnelReportRequest.Builder addDateRanges(DateRange.Builder builderForValue)

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`DateRange.Builder`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

addDateRanges(int index, DateRange value)

public RunFunnelReportRequest.Builder addDateRanges(int index, DateRange value)

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`value`	`DateRange`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

addDateRanges(int index, DateRange.Builder builderForValue)

public RunFunnelReportRequest.Builder addDateRanges(int index, DateRange.Builder builderForValue)

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`DateRange.Builder`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

addDateRangesBuilder()

public DateRange.Builder addDateRangesBuilder()

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`DateRange.Builder`

addDateRangesBuilder(int index)

public DateRange.Builder addDateRangesBuilder(int index)

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DateRange.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunFunnelReportRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSegments(Segment value)

public RunFunnelReportRequest.Builder addSegments(Segment value)

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Segment`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

addSegments(Segment.Builder builderForValue)

public RunFunnelReportRequest.Builder addSegments(Segment.Builder builderForValue)

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`Segment.Builder`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

addSegments(int index, Segment value)

public RunFunnelReportRequest.Builder addSegments(int index, Segment value)

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`value`	`Segment`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

addSegments(int index, Segment.Builder builderForValue)

public RunFunnelReportRequest.Builder addSegments(int index, Segment.Builder builderForValue)

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Segment.Builder`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

addSegmentsBuilder()

public Segment.Builder addSegmentsBuilder()

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Segment.Builder`

addSegmentsBuilder(int index)

public Segment.Builder addSegmentsBuilder(int index)

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Segment.Builder`

build()

public RunFunnelReportRequest build()

Returns
Type	Description
`RunFunnelReportRequest`

buildPartial()

public RunFunnelReportRequest buildPartial()

Returns
Type	Description
`RunFunnelReportRequest`

clear()

public RunFunnelReportRequest.Builder clear()

Returns
Type	Description
`RunFunnelReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDateRanges()

public RunFunnelReportRequest.Builder clearDateRanges()

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`RunFunnelReportRequest.Builder`

clearDimensionFilter()

public RunFunnelReportRequest.Builder clearDimensionFilter()

Optional. Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see Creating a Report: Dimension Filters for examples. Metrics cannot be used in this filter.

.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`RunFunnelReportRequest.Builder`

clearField(Descriptors.FieldDescriptor field)

public RunFunnelReportRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFunnel()

public RunFunnelReportRequest.Builder clearFunnel()

Optional. The configuration of this request's funnel. This funnel configuration is required.

.google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`RunFunnelReportRequest.Builder`

clearFunnelBreakdown()

public RunFunnelReportRequest.Builder clearFunnelBreakdown()

Optional. If specified, this breakdown adds a dimension to the funnel table sub report response. This breakdown dimension expands each funnel step to the unique values of the breakdown dimension. For example, a breakdown by the deviceCategory dimension will create rows for mobile, tablet, desktop, and the total.

.google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`RunFunnelReportRequest.Builder`

clearFunnelNextAction()

public RunFunnelReportRequest.Builder clearFunnelNextAction()

Optional. If specified, next action adds a dimension to the funnel visualization sub report response. This next action dimension expands each funnel step to the unique values of the next action. For example a next action of the eventName dimension will create rows for several events (for example session_start & click) and the total.

Next action only supports eventName and most Page / Screen dimensions like pageTitle and pagePath.

.google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`RunFunnelReportRequest.Builder`

clearFunnelVisualizationType()

public RunFunnelReportRequest.Builder clearFunnelVisualizationType()

Optional. The funnel visualization type controls the dimensions present in the funnel visualization sub report response. If not specified, STANDARD_FUNNEL is used.

.google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`RunFunnelReportRequest.Builder`	This builder for chaining.

clearLimit()

public RunFunnelReportRequest.Builder clearLimit()

Optional. The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit.

int64 limit = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`RunFunnelReportRequest.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RunFunnelReportRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearProperty()

public RunFunnelReportRequest.Builder clearProperty()

Optional. A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

Example: properties/1234

string property = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`RunFunnelReportRequest.Builder`	This builder for chaining.

clearReturnPropertyQuota()

public RunFunnelReportRequest.Builder clearReturnPropertyQuota()

Optional. Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

bool return_property_quota = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`RunFunnelReportRequest.Builder`	This builder for chaining.

clearSegments()

public RunFunnelReportRequest.Builder clearSegments()

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`RunFunnelReportRequest.Builder`

clone()

public RunFunnelReportRequest.Builder clone()

Returns
Type	Description
`RunFunnelReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDateRanges(int index)

public DateRange getDateRanges(int index)

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DateRange`

getDateRangesBuilder(int index)

public DateRange.Builder getDateRangesBuilder(int index)

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DateRange.Builder`

getDateRangesBuilderList()

public List<DateRange.Builder> getDateRangesBuilderList()

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Builder>`

getDateRangesCount()

public int getDateRangesCount()

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getDateRangesList()

public List<DateRange> getDateRangesList()

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<DateRange>`

getDateRangesOrBuilder(int index)

public DateRangeOrBuilder getDateRangesOrBuilder(int index)

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DateRangeOrBuilder`

getDateRangesOrBuilderList()

public List<? extends DateRangeOrBuilder> getDateRangesOrBuilderList()

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

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

getDefaultInstanceForType()

public RunFunnelReportRequest getDefaultInstanceForType()

Returns
Type	Description
`RunFunnelReportRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDimensionFilter()

public FilterExpression getDimensionFilter()

.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FilterExpression`	The dimensionFilter.

getDimensionFilterBuilder()

public FilterExpression.Builder getDimensionFilterBuilder()

.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FilterExpression.Builder`

getDimensionFilterOrBuilder()

public FilterExpressionOrBuilder getDimensionFilterOrBuilder()

.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FilterExpressionOrBuilder`

getFunnel()

public Funnel getFunnel()

Optional. The configuration of this request's funnel. This funnel configuration is required.

.google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Funnel`	The funnel.

getFunnelBreakdown()

public FunnelBreakdown getFunnelBreakdown()

.google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FunnelBreakdown`	The funnelBreakdown.

getFunnelBreakdownBuilder()

public FunnelBreakdown.Builder getFunnelBreakdownBuilder()

.google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FunnelBreakdown.Builder`

getFunnelBreakdownOrBuilder()

public FunnelBreakdownOrBuilder getFunnelBreakdownOrBuilder()

.google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FunnelBreakdownOrBuilder`

getFunnelBuilder()

public Funnel.Builder getFunnelBuilder()

Optional. The configuration of this request's funnel. This funnel configuration is required.

.google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Funnel.Builder`

getFunnelNextAction()

public FunnelNextAction getFunnelNextAction()

Next action only supports eventName and most Page / Screen dimensions like pageTitle and pagePath.

.google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FunnelNextAction`	The funnelNextAction.

getFunnelNextActionBuilder()

public FunnelNextAction.Builder getFunnelNextActionBuilder()

Next action only supports eventName and most Page / Screen dimensions like pageTitle and pagePath.

.google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FunnelNextAction.Builder`

getFunnelNextActionOrBuilder()

public FunnelNextActionOrBuilder getFunnelNextActionOrBuilder()

Next action only supports eventName and most Page / Screen dimensions like pageTitle and pagePath.

.google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FunnelNextActionOrBuilder`

getFunnelOrBuilder()

public FunnelOrBuilder getFunnelOrBuilder()

Optional. The configuration of this request's funnel. This funnel configuration is required.

.google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FunnelOrBuilder`

getFunnelVisualizationType()

public RunFunnelReportRequest.FunnelVisualizationType getFunnelVisualizationType()

Optional. The funnel visualization type controls the dimensions present in the funnel visualization sub report response. If not specified, STANDARD_FUNNEL is used.

.google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`RunFunnelReportRequest.FunnelVisualizationType`	The funnelVisualizationType.

getFunnelVisualizationTypeValue()

public int getFunnelVisualizationTypeValue()

Optional. The funnel visualization type controls the dimensions present in the funnel visualization sub report response. If not specified, STANDARD_FUNNEL is used.

.google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The enum numeric value on the wire for funnelVisualizationType.

getLimit()

public long getLimit()

Optional. The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit.

int64 limit = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`long`	The limit.

getProperty()

public String getProperty()

Example: properties/1234

string property = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The property.

getPropertyBytes()

public ByteString getPropertyBytes()

Example: properties/1234

string property = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for property.

getReturnPropertyQuota()

public boolean getReturnPropertyQuota()

Optional. Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

bool return_property_quota = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The returnPropertyQuota.

getSegments(int index)

public Segment getSegments(int index)

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Segment`

getSegmentsBuilder(int index)

public Segment.Builder getSegmentsBuilder(int index)

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Segment.Builder`

getSegmentsBuilderList()

public List<Segment.Builder> getSegmentsBuilderList()

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Builder>`

getSegmentsCount()

public int getSegmentsCount()

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getSegmentsList()

public List<Segment> getSegmentsList()

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Segment>`

getSegmentsOrBuilder(int index)

public SegmentOrBuilder getSegmentsOrBuilder(int index)

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SegmentOrBuilder`

getSegmentsOrBuilderList()

public List<? extends SegmentOrBuilder> getSegmentsOrBuilderList()

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

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

hasDimensionFilter()

public boolean hasDimensionFilter()

.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the dimensionFilter field is set.

hasFunnel()

public boolean hasFunnel()

Optional. The configuration of this request's funnel. This funnel configuration is required.

.google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the funnel field is set.

hasFunnelBreakdown()

public boolean hasFunnelBreakdown()

.google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the funnelBreakdown field is set.

hasFunnelNextAction()

public boolean hasFunnelNextAction()

Next action only supports eventName and most Page / Screen dimensions like pageTitle and pagePath.

.google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the funnelNextAction field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeDimensionFilter(FilterExpression value)

public RunFunnelReportRequest.Builder mergeDimensionFilter(FilterExpression value)

.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`FilterExpression`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

mergeFrom(RunFunnelReportRequest other)

public RunFunnelReportRequest.Builder mergeFrom(RunFunnelReportRequest other)

Parameter
Name	Description
`other`	`RunFunnelReportRequest`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunFunnelReportRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public RunFunnelReportRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFunnel(Funnel value)

public RunFunnelReportRequest.Builder mergeFunnel(Funnel value)

Optional. The configuration of this request's funnel. This funnel configuration is required.

.google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Funnel`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

mergeFunnelBreakdown(FunnelBreakdown value)

public RunFunnelReportRequest.Builder mergeFunnelBreakdown(FunnelBreakdown value)

.google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`FunnelBreakdown`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

mergeFunnelNextAction(FunnelNextAction value)

public RunFunnelReportRequest.Builder mergeFunnelNextAction(FunnelNextAction value)

Next action only supports eventName and most Page / Screen dimensions like pageTitle and pagePath.

.google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`FunnelNextAction`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunFunnelReportRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeDateRanges(int index)

public RunFunnelReportRequest.Builder removeDateRanges(int index)

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

removeSegments(int index)

public RunFunnelReportRequest.Builder removeSegments(int index)

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

setDateRanges(int index, DateRange value)

public RunFunnelReportRequest.Builder setDateRanges(int index, DateRange value)

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`value`	`DateRange`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

setDateRanges(int index, DateRange.Builder builderForValue)

public RunFunnelReportRequest.Builder setDateRanges(int index, DateRange.Builder builderForValue)

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`DateRange.Builder`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

setDimensionFilter(FilterExpression value)

public RunFunnelReportRequest.Builder setDimensionFilter(FilterExpression value)

.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`FilterExpression`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

setDimensionFilter(FilterExpression.Builder builderForValue)

public RunFunnelReportRequest.Builder setDimensionFilter(FilterExpression.Builder builderForValue)

.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`FilterExpression.Builder`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public RunFunnelReportRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFunnel(Funnel value)

public RunFunnelReportRequest.Builder setFunnel(Funnel value)

Optional. The configuration of this request's funnel. This funnel configuration is required.

.google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Funnel`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

setFunnel(Funnel.Builder builderForValue)

public RunFunnelReportRequest.Builder setFunnel(Funnel.Builder builderForValue)

Optional. The configuration of this request's funnel. This funnel configuration is required.

.google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`Funnel.Builder`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

setFunnelBreakdown(FunnelBreakdown value)

public RunFunnelReportRequest.Builder setFunnelBreakdown(FunnelBreakdown value)

.google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`FunnelBreakdown`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

setFunnelBreakdown(FunnelBreakdown.Builder builderForValue)

public RunFunnelReportRequest.Builder setFunnelBreakdown(FunnelBreakdown.Builder builderForValue)

.google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`FunnelBreakdown.Builder`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

setFunnelNextAction(FunnelNextAction value)

public RunFunnelReportRequest.Builder setFunnelNextAction(FunnelNextAction value)

Next action only supports eventName and most Page / Screen dimensions like pageTitle and pagePath.

.google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`FunnelNextAction`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

setFunnelNextAction(FunnelNextAction.Builder builderForValue)

public RunFunnelReportRequest.Builder setFunnelNextAction(FunnelNextAction.Builder builderForValue)

Next action only supports eventName and most Page / Screen dimensions like pageTitle and pagePath.

.google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`FunnelNextAction.Builder`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

setFunnelVisualizationType(RunFunnelReportRequest.FunnelVisualizationType value)

public RunFunnelReportRequest.Builder setFunnelVisualizationType(RunFunnelReportRequest.FunnelVisualizationType value)

Optional. The funnel visualization type controls the dimensions present in the funnel visualization sub report response. If not specified, STANDARD_FUNNEL is used.

.google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`RunFunnelReportRequest.FunnelVisualizationType` The funnelVisualizationType to set.

Returns
Type	Description
`RunFunnelReportRequest.Builder`	This builder for chaining.

setFunnelVisualizationTypeValue(int value)

public RunFunnelReportRequest.Builder setFunnelVisualizationTypeValue(int value)

Optional. The funnel visualization type controls the dimensions present in the funnel visualization sub report response. If not specified, STANDARD_FUNNEL is used.

.google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for funnelVisualizationType to set.

Returns
Type	Description
`RunFunnelReportRequest.Builder`	This builder for chaining.

setLimit(long value)

public RunFunnelReportRequest.Builder setLimit(long value)

Optional. The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit.

int64 limit = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`long` The limit to set.

Returns
Type	Description
`RunFunnelReportRequest.Builder`	This builder for chaining.

setProperty(String value)

public RunFunnelReportRequest.Builder setProperty(String value)

Example: properties/1234

string property = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`String` The property to set.

Returns
Type	Description
`RunFunnelReportRequest.Builder`	This builder for chaining.

setPropertyBytes(ByteString value)

public RunFunnelReportRequest.Builder setPropertyBytes(ByteString value)

Example: properties/1234

string property = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ByteString` The bytes for property to set.

Returns
Type	Description
`RunFunnelReportRequest.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setReturnPropertyQuota(boolean value)

public RunFunnelReportRequest.Builder setReturnPropertyQuota(boolean value)

Optional. Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

bool return_property_quota = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`boolean` The returnPropertyQuota to set.

Returns
Type	Description
`RunFunnelReportRequest.Builder`	This builder for chaining.

setSegments(int index, Segment value)

public RunFunnelReportRequest.Builder setSegments(int index, Segment value)

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`value`	`Segment`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

setSegments(int index, Segment.Builder builderForValue)

public RunFunnelReportRequest.Builder setSegments(int index, Segment.Builder builderForValue)

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Segment.Builder`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final RunFunnelReportRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`RunFunnelReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)