Interface RunFunnelReportRequestOrBuilder (0.57.0) 

public interface RunFunnelReportRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDateRanges(int index)

public abstract DateRange getDateRanges(int index)

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
index int
Returns
Type Description
DateRange

getDateRangesCount()

public abstract int getDateRangesCount()

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];

Returns
Type Description
int

getDateRangesList()

public abstract List<DateRange> getDateRangesList()

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];

Returns
Type Description
List<DateRange>

getDateRangesOrBuilder(int index)

public abstract DateRangeOrBuilder getDateRangesOrBuilder(int index)

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
index int
Returns
Type Description
DateRangeOrBuilder

getDateRangesOrBuilderList()

public abstract List<? extends DateRangeOrBuilder> getDateRangesOrBuilderList()

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];

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

getDimensionFilter()

public abstract FilterExpression getDimensionFilter()

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
FilterExpression

The dimensionFilter.

getDimensionFilterOrBuilder()

public abstract FilterExpressionOrBuilder getDimensionFilterOrBuilder()

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
FilterExpressionOrBuilder

getFunnel()

public abstract 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 abstract FunnelBreakdown getFunnelBreakdown()

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
FunnelBreakdown

The funnelBreakdown.

getFunnelBreakdownOrBuilder()

public abstract FunnelBreakdownOrBuilder getFunnelBreakdownOrBuilder()

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
FunnelBreakdownOrBuilder

getFunnelNextAction()

public abstract FunnelNextAction getFunnelNextAction()

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
FunnelNextAction

The funnelNextAction.

getFunnelNextActionOrBuilder()

public abstract FunnelNextActionOrBuilder getFunnelNextActionOrBuilder()

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
FunnelNextActionOrBuilder

getFunnelOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract String getProperty()

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
String

The property.

getPropertyBytes()

public abstract ByteString getPropertyBytes()

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
ByteString

The bytes for property.

getReturnPropertyQuota()

public abstract 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 abstract 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

getSegmentsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasDimensionFilter()

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
boolean

Whether the dimensionFilter field is set.

hasFunnel()

public abstract 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 abstract boolean hasFunnelBreakdown()

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
boolean

Whether the funnelBreakdown field is set.

hasFunnelNextAction()

public abstract boolean hasFunnelNextAction()

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
boolean

Whether the funnelNextAction field is set.