com.google.analytics.data.v1alpha

Interface RunFunnelReportRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RunFunnelReportRequest, RunFunnelReportRequest.Builder

public interface RunFunnelReportRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
DateRange	getDateRanges(int index) Optional.
int	getDateRangesCount() Optional.
List<DateRange>	getDateRangesList() Optional.
DateRangeOrBuilder	getDateRangesOrBuilder(int index) Optional.
List<? extends DateRangeOrBuilder>	getDateRangesOrBuilderList() Optional.
FilterExpression	getDimensionFilter() Optional.
FilterExpressionOrBuilder	getDimensionFilterOrBuilder() Optional.
Funnel	getFunnel() Optional.
FunnelBreakdown	getFunnelBreakdown() Optional.
FunnelBreakdownOrBuilder	getFunnelBreakdownOrBuilder() Optional.
FunnelNextAction	getFunnelNextAction() Optional.
FunnelNextActionOrBuilder	getFunnelNextActionOrBuilder() Optional.
FunnelOrBuilder	getFunnelOrBuilder() Optional.
RunFunnelReportRequest.FunnelVisualizationType	getFunnelVisualizationType() Optional.
int	getFunnelVisualizationTypeValue() Optional.
long	getLimit() Optional.
String	getProperty() Optional.
com.google.protobuf.ByteString	getPropertyBytes() Optional.
boolean	getReturnPropertyQuota() Optional.
Segment	getSegments(int index) Optional.
int	getSegmentsCount() Optional.
List<Segment>	getSegmentsList() Optional.
SegmentOrBuilder	getSegmentsOrBuilder(int index) Optional.
List<? extends SegmentOrBuilder>	getSegmentsOrBuilderList() Optional.
boolean	hasDimensionFilter() Optional.
boolean	hasFunnel() Optional.
boolean	hasFunnelBreakdown() Optional.
boolean	hasFunnelNextAction() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getProperty

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](https://developers.google.com/analytics/devguides/reporting/data/v1/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:

The property.

getPropertyBytes

com.google.protobuf.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](https://developers.google.com/analytics/devguides/reporting/data/v1/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:

The bytes for property.

getDateRangesList

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

getDateRanges

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

getDateRangesCount

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

getDateRangesOrBuilderList

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

getDateRangesOrBuilder

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

hasFunnel

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:

Whether the funnel field is set.

getFunnel

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:

The funnel.

getFunnelOrBuilder

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

hasFunnelBreakdown

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:

Whether the funnelBreakdown field is set.

getFunnelBreakdown

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:

The funnelBreakdown.

getFunnelBreakdownOrBuilder

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

hasFunnelNextAction

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:

Whether the funnelNextAction field is set.

getFunnelNextAction

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:

The funnelNextAction.

getFunnelNextActionOrBuilder

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

getFunnelVisualizationTypeValue

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:

The enum numeric value on the wire for funnelVisualizationType.

getFunnelVisualizationType

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:

The funnelVisualizationType.

getSegmentsList

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

getSegments

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

getSegmentsCount

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

getSegmentsOrBuilderList

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

getSegmentsOrBuilder

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

getLimit

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:

The limit.

hasDimensionFilter

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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#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:

Whether the dimensionFilter field is set.

getDimensionFilter

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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#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:

The dimensionFilter.

getDimensionFilterOrBuilder

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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
 for examples. Metrics cannot be used in this filter.
 

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

getReturnPropertyQuota

boolean getReturnPropertyQuota()

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

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

Returns:

The returnPropertyQuota.