- 0.63.0 (latest)
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
public interface RunPivotReportRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCohortSpec()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
CohortSpec |
The cohortSpec. |
getCohortSpecOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
CohortSpecOrBuilder |
|
getComparisons(int index)
public abstract Comparison getComparisons(int index)Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.
repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Comparison |
|
getComparisonsCount()
public abstract int getComparisonsCount()Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.
repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getComparisonsList()
public abstract List<Comparison> getComparisonsList()Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.
repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Comparison> |
|
getComparisonsOrBuilder(int index)
public abstract ComparisonOrBuilder getComparisonsOrBuilder(int index)Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.
repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ComparisonOrBuilder |
|
getComparisonsOrBuilderList()
public abstract List<? extends ComparisonOrBuilder> getComparisonsOrBuilderList()Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.
repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.analytics.data.v1beta.ComparisonOrBuilder> |
|
getCurrencyCode()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
String |
The currencyCode. |
getCurrencyCodeBytes()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for currencyCode. |
getDateRanges(int index)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
DateRange |
|
getDateRangesCount()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
int |
|
getDateRangesList()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
List<DateRange> |
|
getDateRangesOrBuilder(int index)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
DateRangeOrBuilder |
|
getDateRangesOrBuilderList()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.analytics.data.v1beta.DateRangeOrBuilder> |
|
getDimensionFilter()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
FilterExpression |
The dimensionFilter. |
getDimensionFilterOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
FilterExpressionOrBuilder |
|
getDimensions(int index)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Dimension |
|
getDimensionsCount()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
int |
|
getDimensionsList()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
List<Dimension> |
|
getDimensionsOrBuilder(int index)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
DimensionOrBuilder |
|
getDimensionsOrBuilderList()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.analytics.data.v1beta.DimensionOrBuilder> |
|
getKeepEmptyRows()
public abstract 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.
Regardless of this keep_empty_rows setting, only data recorded by the
Google Analytics (GA4) property can be displayed in a report.
For example if a property never logs a purchase event, then a query for
the eventName dimension and eventCount metric will not have a row
eventName: "purchase" and eventCount: 0.
bool keep_empty_rows = 10;
| Returns | |
|---|---|
| Type | Description |
boolean |
The keepEmptyRows. |
getMetricFilter()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
FilterExpression |
The metricFilter. |
getMetricFilterOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
FilterExpressionOrBuilder |
|
getMetrics(int index)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Metric |
|
getMetricsCount()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
int |
|
getMetricsList()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
List<Metric> |
|
getMetricsOrBuilder(int index)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MetricOrBuilder |
|
getMetricsOrBuilderList()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.analytics.data.v1beta.MetricOrBuilder> |
|
getPivots(int index)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Pivot |
|
getPivotsCount()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
int |
|
getPivotsList()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
List<Pivot> |
|
getPivotsOrBuilder(int index)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
PivotOrBuilder |
|
getPivotsOrBuilderList()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.analytics.data.v1beta.PivotOrBuilder> |
|
getProperty()
public abstract String 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. Within a batch request, this property should either be unspecified or consistent with the batch-level property.
Example: properties/1234
string property = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The property. |
getPropertyBytes()
public abstract 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. Within a batch request, this property should either be unspecified or consistent with the batch-level property.
Example: properties/1234
string property = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for property. |
getReturnPropertyQuota()
public abstract boolean getReturnPropertyQuota()Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.
bool return_property_quota = 11;
| Returns | |
|---|---|
| Type | Description |
boolean |
The returnPropertyQuota. |
hasCohortSpec()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the cohortSpec field is set. |
hasDimensionFilter()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the dimensionFilter field is set. |
hasMetricFilter()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the metricFilter field is set. |