public static interface ReportTask.ReportDefinitionOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCohortSpec()
public abstract CohortSpec getCohortSpec()Optional. Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.
.google.analytics.data.v1alpha.CohortSpec cohort_spec = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CohortSpec |
The cohortSpec. |
getCohortSpecOrBuilder()
public abstract CohortSpecOrBuilder getCohortSpecOrBuilder()Optional. Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.
.google.analytics.data.v1alpha.CohortSpec cohort_spec = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CohortSpecOrBuilder |
|
getCurrencyCode()
public abstract String getCurrencyCode()Optional. 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 = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The currencyCode. |
getCurrencyCodeBytes()
public abstract ByteString getCurrencyCodeBytes()Optional. 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 = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for currencyCode. |
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. In a cohort request,
this dateRanges must be unspecified.
repeated .google.analytics.data.v1alpha.DateRange date_ranges = 4 [(.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. In a cohort request,
this dateRanges must be unspecified.
repeated .google.analytics.data.v1alpha.DateRange date_ranges = 4 [(.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. In a cohort request,
this dateRanges must be unspecified.
repeated .google.analytics.data.v1alpha.DateRange date_ranges = 4 [(.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. In a cohort request,
this dateRanges must be unspecified.
repeated .google.analytics.data.v1alpha.DateRange date_ranges = 4 [(.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. In a cohort request,
this dateRanges must be unspecified.
repeated .google.analytics.data.v1alpha.DateRange date_ranges = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.analytics.data.v1alpha.DateRangeOrBuilder> |
|
getDimensionFilter()
public abstract FilterExpression getDimensionFilter()Optional. Dimension filters let you ask for only specific dimension values in the report. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter.
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FilterExpression |
The dimensionFilter. |
getDimensionFilterOrBuilder()
public abstract FilterExpressionOrBuilder getDimensionFilterOrBuilder()Optional. Dimension filters let you ask for only specific dimension values in the report. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter.
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FilterExpressionOrBuilder |
|
getDimensions(int index)
public abstract Dimension getDimensions(int index)Optional. The dimensions requested and displayed.
repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Dimension |
|
getDimensionsCount()
public abstract int getDimensionsCount()Optional. The dimensions requested and displayed.
repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getDimensionsList()
public abstract List<Dimension> getDimensionsList()Optional. The dimensions requested and displayed.
repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Dimension> |
|
getDimensionsOrBuilder(int index)
public abstract DimensionOrBuilder getDimensionsOrBuilder(int index)Optional. The dimensions requested and displayed.
repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
DimensionOrBuilder |
|
getDimensionsOrBuilderList()
public abstract List<? extends DimensionOrBuilder> getDimensionsOrBuilderList()Optional. The dimensions requested and displayed.
repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.analytics.data.v1alpha.DimensionOrBuilder> |
|
getKeepEmptyRows()
public abstract boolean getKeepEmptyRows()Optional. 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
containing eventName: "purchase" and eventCount: 0.
bool keep_empty_rows = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The keepEmptyRows. |
getLimit()
public abstract long getLimit() Optional. The number of rows to return in the Report. 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. For instance, there are
fewer than 300 possible values for the dimension country, so when
reporting on only country, you can't get more than 300 rows, even if
you set limit to a higher value.
int64 limit = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
long |
The limit. |
getMetricAggregations(int index)
public abstract MetricAggregation getMetricAggregations(int index)Optional. Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
MetricAggregation |
The metricAggregations at the given index. |
getMetricAggregationsCount()
public abstract int getMetricAggregationsCount()Optional. Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of metricAggregations. |
getMetricAggregationsList()
public abstract List<MetricAggregation> getMetricAggregationsList()Optional. Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<MetricAggregation> |
A list containing the metricAggregations. |
getMetricAggregationsValue(int index)
public abstract int getMetricAggregationsValue(int index)Optional. Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of metricAggregations at the given index. |
getMetricAggregationsValueList()
public abstract List<Integer> getMetricAggregationsValueList()Optional. Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for metricAggregations. |
getMetricFilter()
public abstract FilterExpression getMetricFilter()Optional. The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter.
.google.analytics.data.v1alpha.FilterExpression metric_filter = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FilterExpression |
The metricFilter. |
getMetricFilterOrBuilder()
public abstract FilterExpressionOrBuilder getMetricFilterOrBuilder()Optional. The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter.
.google.analytics.data.v1alpha.FilterExpression metric_filter = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FilterExpressionOrBuilder |
|
getMetrics(int index)
public abstract Metric getMetrics(int index)Optional. The metrics requested and displayed.
repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Metric |
|
getMetricsCount()
public abstract int getMetricsCount()Optional. The metrics requested and displayed.
repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getMetricsList()
public abstract List<Metric> getMetricsList()Optional. The metrics requested and displayed.
repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Metric> |
|
getMetricsOrBuilder(int index)
public abstract MetricOrBuilder getMetricsOrBuilder(int index)Optional. The metrics requested and displayed.
repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MetricOrBuilder |
|
getMetricsOrBuilderList()
public abstract List<? extends MetricOrBuilder> getMetricsOrBuilderList()Optional. The metrics requested and displayed.
repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.analytics.data.v1alpha.MetricOrBuilder> |
|
getOffset()
public abstract long getOffset()Optional. The row count of the start row from Google Analytics Storage. The first row is counted as row 0.
When creating a report task, the offset and limit parameters define
the subset of data rows from Google Analytics storage to be included in
the generated report. For example, if there are a total of 300,000 rows
in Google Analytics storage, the initial report task may have the
first 10,000 rows with a limit of 10,000 and an offset of 0.
Subsequently, another report task could cover the next 10,000 rows with a
limit of 10,000 and an offset of 10,000.
int64 offset = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
long |
The offset. |
getOrderBys(int index)
public abstract OrderBy getOrderBys(int index)Optional. Specifies how rows are ordered in the response.
repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
OrderBy |
|
getOrderBysCount()
public abstract int getOrderBysCount()Optional. Specifies how rows are ordered in the response.
repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getOrderBysList()
public abstract List<OrderBy> getOrderBysList()Optional. Specifies how rows are ordered in the response.
repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<OrderBy> |
|
getOrderBysOrBuilder(int index)
public abstract OrderByOrBuilder getOrderBysOrBuilder(int index)Optional. Specifies how rows are ordered in the response.
repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
OrderByOrBuilder |
|
getOrderBysOrBuilderList()
public abstract List<? extends OrderByOrBuilder> getOrderBysOrBuilderList()Optional. Specifies how rows are ordered in the response.
repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.analytics.data.v1alpha.OrderByOrBuilder> |
|
hasCohortSpec()
public abstract boolean hasCohortSpec()Optional. Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.
.google.analytics.data.v1alpha.CohortSpec cohort_spec = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the cohortSpec field is set. |
hasDimensionFilter()
public abstract boolean hasDimensionFilter()Optional. Dimension filters let you ask for only specific dimension values in the report. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter.
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the dimensionFilter field is set. |
hasMetricFilter()
public abstract boolean hasMetricFilter()Optional. The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter.
.google.analytics.data.v1alpha.FilterExpression metric_filter = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the metricFilter field is set. |