public interface RunFunnelReportRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
DateRange |
getDateRanges(int index)
Date ranges of data to read.
|
int |
getDateRangesCount()
Date ranges of data to read.
|
List<DateRange> |
getDateRangesList()
Date ranges of data to read.
|
DateRangeOrBuilder |
getDateRangesOrBuilder(int index)
Date ranges of data to read.
|
List<? extends DateRangeOrBuilder> |
getDateRangesOrBuilderList()
Date ranges of data to read.
|
FilterExpression |
getDimensionFilter()
Dimension filters allow you to ask for only specific dimension values in
the report.
|
FilterExpressionOrBuilder |
getDimensionFilterOrBuilder()
Dimension filters allow you to ask for only specific dimension values in
the report.
|
Funnel |
getFunnel()
The configuration of this request's funnel.
|
FunnelBreakdown |
getFunnelBreakdown()
If specified, this breakdown adds a dimension to the funnel table sub
report response.
|
FunnelBreakdownOrBuilder |
getFunnelBreakdownOrBuilder()
If specified, this breakdown adds a dimension to the funnel table sub
report response.
|
FunnelNextAction |
getFunnelNextAction()
If specified, next action adds a dimension to the funnel visualization sub
report response.
|
FunnelNextActionOrBuilder |
getFunnelNextActionOrBuilder()
If specified, next action adds a dimension to the funnel visualization sub
report response.
|
FunnelOrBuilder |
getFunnelOrBuilder()
The configuration of this request's funnel.
|
RunFunnelReportRequest.FunnelVisualizationType |
getFunnelVisualizationType()
The funnel visualization type controls the dimensions present in the funnel
visualization sub report response.
|
int |
getFunnelVisualizationTypeValue()
The funnel visualization type controls the dimensions present in the funnel
visualization sub report response.
|
long |
getLimit()
The number of rows to return.
|
String |
getProperty()
A Google Analytics GA4 property identifier whose events are tracked.
|
com.google.protobuf.ByteString |
getPropertyBytes()
A Google Analytics GA4 property identifier whose events are tracked.
|
boolean |
getReturnPropertyQuota()
Toggles whether to return the current state of this Analytics Property's
quota.
|
Segment |
getSegments(int index)
The configurations of segments.
|
int |
getSegmentsCount()
The configurations of segments.
|
List<Segment> |
getSegmentsList()
The configurations of segments.
|
SegmentOrBuilder |
getSegmentsOrBuilder(int index)
The configurations of segments.
|
List<? extends SegmentOrBuilder> |
getSegmentsOrBuilderList()
The configurations of segments.
|
boolean |
hasDimensionFilter()
Dimension filters allow you to ask for only specific dimension values in
the report.
|
boolean |
hasFunnel()
The configuration of this request's funnel.
|
boolean |
hasFunnelBreakdown()
If specified, this breakdown adds a dimension to the funnel table sub
report response.
|
boolean |
hasFunnelNextAction()
If specified, next action adds a dimension to the funnel visualization sub
report response.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofString getProperty()
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;com.google.protobuf.ByteString getPropertyBytes()
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;List<DateRange> getDateRangesList()
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;DateRange getDateRanges(int index)
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;int getDateRangesCount()
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;List<? extends DateRangeOrBuilder> getDateRangesOrBuilderList()
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;DateRangeOrBuilder getDateRangesOrBuilder(int index)
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;boolean hasFunnel()
The configuration of this request's funnel. This funnel configuration is required.
.google.analytics.data.v1alpha.Funnel funnel = 3;Funnel getFunnel()
The configuration of this request's funnel. This funnel configuration is required.
.google.analytics.data.v1alpha.Funnel funnel = 3;FunnelOrBuilder getFunnelOrBuilder()
The configuration of this request's funnel. This funnel configuration is required.
.google.analytics.data.v1alpha.Funnel funnel = 3;boolean hasFunnelBreakdown()
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;FunnelBreakdown getFunnelBreakdown()
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;FunnelBreakdownOrBuilder getFunnelBreakdownOrBuilder()
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;boolean hasFunnelNextAction()
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 (i.e. `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;FunnelNextAction getFunnelNextAction()
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 (i.e. `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;FunnelNextActionOrBuilder getFunnelNextActionOrBuilder()
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 (i.e. `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;int getFunnelVisualizationTypeValue()
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;
RunFunnelReportRequest.FunnelVisualizationType getFunnelVisualizationType()
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;
List<Segment> getSegmentsList()
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;Segment getSegments(int index)
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;int getSegmentsCount()
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;List<? extends SegmentOrBuilder> getSegmentsOrBuilderList()
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;SegmentOrBuilder getSegmentsOrBuilder(int index)
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;long getLimit()
The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,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;boolean hasDimensionFilter()
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;FilterExpression getDimensionFilter()
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;FilterExpressionOrBuilder getDimensionFilterOrBuilder()
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;boolean getReturnPropertyQuota()
Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
bool return_property_quota = 12;Copyright © 2023 Google LLC. All rights reserved.