public interface RunPivotReportRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
CohortSpec |
getCohortSpec()
Cohort group associated with this request.
|
CohortSpecOrBuilder |
getCohortSpecOrBuilder()
Cohort group associated with this request.
|
String |
getCurrencyCode()
A currency code in ISO4217 format, such as "AED", "USD", "JPY".
|
com.google.protobuf.ByteString |
getCurrencyCodeBytes()
A currency code in ISO4217 format, such as "AED", "USD", "JPY".
|
DateRange |
getDateRanges(int index)
The date range to retrieve event data for the report.
|
int |
getDateRangesCount()
The date range to retrieve event data for the report.
|
List<DateRange> |
getDateRangesList()
The date range to retrieve event data for the report.
|
DateRangeOrBuilder |
getDateRangesOrBuilder(int index)
The date range to retrieve event data for the report.
|
List<? extends DateRangeOrBuilder> |
getDateRangesOrBuilderList()
The date range to retrieve event data for the report.
|
FilterExpression |
getDimensionFilter()
The filter clause of dimensions.
|
FilterExpressionOrBuilder |
getDimensionFilterOrBuilder()
The filter clause of dimensions.
|
Dimension |
getDimensions(int index)
The dimensions requested.
|
int |
getDimensionsCount()
The dimensions requested.
|
List<Dimension> |
getDimensionsList()
The dimensions requested.
|
DimensionOrBuilder |
getDimensionsOrBuilder(int index)
The dimensions requested.
|
List<? extends DimensionOrBuilder> |
getDimensionsOrBuilderList()
The dimensions requested.
|
boolean |
getKeepEmptyRows()
If false or unspecified, each row with all metrics equal to 0 will not be
returned.
|
FilterExpression |
getMetricFilter()
The filter clause of metrics.
|
FilterExpressionOrBuilder |
getMetricFilterOrBuilder()
The filter clause of metrics.
|
Metric |
getMetrics(int index)
The metrics requested, at least one metric needs to be specified.
|
int |
getMetricsCount()
The metrics requested, at least one metric needs to be specified.
|
List<Metric> |
getMetricsList()
The metrics requested, at least one metric needs to be specified.
|
MetricOrBuilder |
getMetricsOrBuilder(int index)
The metrics requested, at least one metric needs to be specified.
|
List<? extends MetricOrBuilder> |
getMetricsOrBuilderList()
The metrics requested, at least one metric needs to be specified.
|
Pivot |
getPivots(int index)
Describes the visual format of the report's dimensions in columns or rows.
|
int |
getPivotsCount()
Describes the visual format of the report's dimensions in columns or rows.
|
List<Pivot> |
getPivotsList()
Describes the visual format of the report's dimensions in columns or rows.
|
PivotOrBuilder |
getPivotsOrBuilder(int index)
Describes the visual format of the report's dimensions in columns or rows.
|
List<? extends PivotOrBuilder> |
getPivotsOrBuilderList()
Describes the visual format of the report's dimensions in columns or rows.
|
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.
|
boolean |
hasCohortSpec()
Cohort group associated with this request.
|
boolean |
hasDimensionFilter()
The filter clause of dimensions.
|
boolean |
hasMetricFilter()
The filter clause of metrics.
|
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<Dimension> getDimensionsList()
The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.
repeated .google.analytics.data.v1beta.Dimension dimensions = 2;Dimension getDimensions(int index)
The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.
repeated .google.analytics.data.v1beta.Dimension dimensions = 2;int getDimensionsCount()
The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.
repeated .google.analytics.data.v1beta.Dimension dimensions = 2;List<? extends DimensionOrBuilder> getDimensionsOrBuilderList()
The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.
repeated .google.analytics.data.v1beta.Dimension dimensions = 2;DimensionOrBuilder getDimensionsOrBuilder(int index)
The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.
repeated .google.analytics.data.v1beta.Dimension dimensions = 2;List<Metric> getMetricsList()
The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.
repeated .google.analytics.data.v1beta.Metric metrics = 3;Metric getMetrics(int index)
The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.
repeated .google.analytics.data.v1beta.Metric metrics = 3;int getMetricsCount()
The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.
repeated .google.analytics.data.v1beta.Metric metrics = 3;List<? extends MetricOrBuilder> getMetricsOrBuilderList()
The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.
repeated .google.analytics.data.v1beta.Metric metrics = 3;MetricOrBuilder getMetricsOrBuilder(int index)
The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.
repeated .google.analytics.data.v1beta.Metric metrics = 3;List<DateRange> getDateRangesList()
The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this `dateRanges` must be unspecified.
repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;DateRange getDateRanges(int index)
The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this `dateRanges` must be unspecified.
repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;int getDateRangesCount()
The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this `dateRanges` must be unspecified.
repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;List<? extends DateRangeOrBuilder> getDateRangesOrBuilderList()
The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this `dateRanges` must be unspecified.
repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;DateRangeOrBuilder getDateRangesOrBuilder(int index)
The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this `dateRanges` must be unspecified.
repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;List<Pivot> getPivotsList()
Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.
repeated .google.analytics.data.v1beta.Pivot pivots = 5;Pivot getPivots(int index)
Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.
repeated .google.analytics.data.v1beta.Pivot pivots = 5;int getPivotsCount()
Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.
repeated .google.analytics.data.v1beta.Pivot pivots = 5;List<? extends PivotOrBuilder> getPivotsOrBuilderList()
Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.
repeated .google.analytics.data.v1beta.Pivot pivots = 5;PivotOrBuilder getPivotsOrBuilder(int index)
Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.
repeated .google.analytics.data.v1beta.Pivot pivots = 5;boolean hasDimensionFilter()
The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
.google.analytics.data.v1beta.FilterExpression dimension_filter = 6;FilterExpression getDimensionFilter()
The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
.google.analytics.data.v1beta.FilterExpression dimension_filter = 6;FilterExpressionOrBuilder getDimensionFilterOrBuilder()
The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
.google.analytics.data.v1beta.FilterExpression dimension_filter = 6;boolean hasMetricFilter()
The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.
.google.analytics.data.v1beta.FilterExpression metric_filter = 7;FilterExpression getMetricFilter()
The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.
.google.analytics.data.v1beta.FilterExpression metric_filter = 7;FilterExpressionOrBuilder getMetricFilterOrBuilder()
The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.
.google.analytics.data.v1beta.FilterExpression metric_filter = 7;String getCurrencyCode()
A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency.
string currency_code = 8;com.google.protobuf.ByteString getCurrencyCodeBytes()
A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency.
string currency_code = 8;boolean hasCohortSpec()
Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.
.google.analytics.data.v1beta.CohortSpec cohort_spec = 9;CohortSpec getCohortSpec()
Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.
.google.analytics.data.v1beta.CohortSpec cohort_spec = 9;CohortSpecOrBuilder getCohortSpecOrBuilder()
Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.
.google.analytics.data.v1beta.CohortSpec cohort_spec = 9;boolean getKeepEmptyRows()
If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.
bool keep_empty_rows = 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 = 11;Copyright © 2022 Google LLC. All rights reserved.