public static final class ReportTask.ReportDefinition.Builder extends GeneratedMessageV3.Builder<ReportTask.ReportDefinition.Builder> implements ReportTask.ReportDefinitionOrBuilderThe definition of how a report should be run.
Protobuf type google.analytics.data.v1alpha.ReportTask.ReportDefinition
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ReportTask.ReportDefinition.BuilderImplements
ReportTask.ReportDefinitionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllDateRanges(Iterable<? extends DateRange> values)
public ReportTask.ReportDefinition.Builder addAllDateRanges(Iterable<? extends DateRange> values) 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 |
values |
Iterable<? extends com.google.analytics.data.v1alpha.DateRange> |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addAllDimensions(Iterable<? extends Dimension> values)
public ReportTask.ReportDefinition.Builder addAllDimensions(Iterable<? extends Dimension> values)Optional. The dimensions requested and displayed.
repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.analytics.data.v1alpha.Dimension> |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addAllMetricAggregations(Iterable<? extends MetricAggregation> values)
public ReportTask.ReportDefinition.Builder addAllMetricAggregations(Iterable<? extends MetricAggregation> values)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 |
values |
Iterable<? extends com.google.analytics.data.v1alpha.MetricAggregation>The metricAggregations to add. |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
addAllMetricAggregationsValue(Iterable<Integer> values)
public ReportTask.ReportDefinition.Builder addAllMetricAggregationsValue(Iterable<Integer> values)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 |
values |
Iterable<Integer>The enum numeric values on the wire for metricAggregations to add. |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
addAllMetrics(Iterable<? extends Metric> values)
public ReportTask.ReportDefinition.Builder addAllMetrics(Iterable<? extends Metric> values)Optional. The metrics requested and displayed.
repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.analytics.data.v1alpha.Metric> |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addAllOrderBys(Iterable<? extends OrderBy> values)
public ReportTask.ReportDefinition.Builder addAllOrderBys(Iterable<? extends OrderBy> values)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 |
values |
Iterable<? extends com.google.analytics.data.v1alpha.OrderBy> |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addDateRanges(DateRange value)
public ReportTask.ReportDefinition.Builder addDateRanges(DateRange value) 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 |
value |
DateRange |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addDateRanges(DateRange.Builder builderForValue)
public ReportTask.ReportDefinition.Builder addDateRanges(DateRange.Builder builderForValue) 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 |
builderForValue |
DateRange.Builder |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addDateRanges(int index, DateRange value)
public ReportTask.ReportDefinition.Builder addDateRanges(int index, DateRange value) 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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
DateRange |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addDateRanges(int index, DateRange.Builder builderForValue)
public ReportTask.ReportDefinition.Builder addDateRanges(int index, DateRange.Builder builderForValue) 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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
DateRange.Builder |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addDateRangesBuilder()
public DateRange.Builder addDateRangesBuilder() 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 |
DateRange.Builder |
|
addDateRangesBuilder(int index)
public DateRange.Builder addDateRangesBuilder(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.Builder |
|
addDimensions(Dimension value)
public ReportTask.ReportDefinition.Builder addDimensions(Dimension value)Optional. The dimensions requested and displayed.
repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Dimension |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addDimensions(Dimension.Builder builderForValue)
public ReportTask.ReportDefinition.Builder addDimensions(Dimension.Builder builderForValue)Optional. The dimensions requested and displayed.
repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Dimension.Builder |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addDimensions(int index, Dimension value)
public ReportTask.ReportDefinition.Builder addDimensions(int index, Dimension value)Optional. The dimensions requested and displayed.
repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Dimension |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addDimensions(int index, Dimension.Builder builderForValue)
public ReportTask.ReportDefinition.Builder addDimensions(int index, Dimension.Builder builderForValue)Optional. The dimensions requested and displayed.
repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Dimension.Builder |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addDimensionsBuilder()
public Dimension.Builder addDimensionsBuilder()Optional. The dimensions requested and displayed.
repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Dimension.Builder |
|
addDimensionsBuilder(int index)
public Dimension.Builder addDimensionsBuilder(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.Builder |
|
addMetricAggregations(MetricAggregation value)
public ReportTask.ReportDefinition.Builder addMetricAggregations(MetricAggregation value)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 |
value |
MetricAggregationThe metricAggregations to add. |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
addMetricAggregationsValue(int value)
public ReportTask.ReportDefinition.Builder addMetricAggregationsValue(int value)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 |
value |
intThe enum numeric value on the wire for metricAggregations to add. |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
addMetrics(Metric value)
public ReportTask.ReportDefinition.Builder addMetrics(Metric value)Optional. The metrics requested and displayed.
repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Metric |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addMetrics(Metric.Builder builderForValue)
public ReportTask.ReportDefinition.Builder addMetrics(Metric.Builder builderForValue)Optional. The metrics requested and displayed.
repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Metric.Builder |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addMetrics(int index, Metric value)
public ReportTask.ReportDefinition.Builder addMetrics(int index, Metric value)Optional. The metrics requested and displayed.
repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Metric |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addMetrics(int index, Metric.Builder builderForValue)
public ReportTask.ReportDefinition.Builder addMetrics(int index, Metric.Builder builderForValue)Optional. The metrics requested and displayed.
repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Metric.Builder |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addMetricsBuilder()
public Metric.Builder addMetricsBuilder()Optional. The metrics requested and displayed.
repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Metric.Builder |
|
addMetricsBuilder(int index)
public Metric.Builder addMetricsBuilder(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.Builder |
|
addOrderBys(OrderBy value)
public ReportTask.ReportDefinition.Builder addOrderBys(OrderBy value)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 |
value |
OrderBy |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addOrderBys(OrderBy.Builder builderForValue)
public ReportTask.ReportDefinition.Builder addOrderBys(OrderBy.Builder builderForValue)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 |
builderForValue |
OrderBy.Builder |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addOrderBys(int index, OrderBy value)
public ReportTask.ReportDefinition.Builder addOrderBys(int index, OrderBy value)Optional. Specifies how rows are ordered in the response.
repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
OrderBy |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addOrderBys(int index, OrderBy.Builder builderForValue)
public ReportTask.ReportDefinition.Builder addOrderBys(int index, OrderBy.Builder builderForValue)Optional. Specifies how rows are ordered in the response.
repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
OrderBy.Builder |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
addOrderBysBuilder()
public OrderBy.Builder addOrderBysBuilder()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 |
OrderBy.Builder |
|
addOrderBysBuilder(int index)
public OrderBy.Builder addOrderBysBuilder(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.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ReportTask.ReportDefinition.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
build()
public ReportTask.ReportDefinition build()| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition |
|
buildPartial()
public ReportTask.ReportDefinition buildPartial()| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition |
|
clear()
public ReportTask.ReportDefinition.Builder clear()| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
clearCohortSpec()
public ReportTask.ReportDefinition.Builder clearCohortSpec()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 |
ReportTask.ReportDefinition.Builder |
|
clearCurrencyCode()
public ReportTask.ReportDefinition.Builder clearCurrencyCode()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 |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
clearDateRanges()
public ReportTask.ReportDefinition.Builder clearDateRanges() 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 |
ReportTask.ReportDefinition.Builder |
|
clearDimensionFilter()
public ReportTask.ReportDefinition.Builder clearDimensionFilter()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 |
ReportTask.ReportDefinition.Builder |
|
clearDimensions()
public ReportTask.ReportDefinition.Builder clearDimensions()Optional. The dimensions requested and displayed.
repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ReportTask.ReportDefinition.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
clearKeepEmptyRows()
public ReportTask.ReportDefinition.Builder clearKeepEmptyRows()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 |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
clearLimit()
public ReportTask.ReportDefinition.Builder clearLimit() 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 |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
clearMetricAggregations()
public ReportTask.ReportDefinition.Builder clearMetricAggregations()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 |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
clearMetricFilter()
public ReportTask.ReportDefinition.Builder clearMetricFilter()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 |
ReportTask.ReportDefinition.Builder |
|
clearMetrics()
public ReportTask.ReportDefinition.Builder clearMetrics()Optional. The metrics requested and displayed.
repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
clearOffset()
public ReportTask.ReportDefinition.Builder clearOffset()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 |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ReportTask.ReportDefinition.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
clearOrderBys()
public ReportTask.ReportDefinition.Builder clearOrderBys()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 |
ReportTask.ReportDefinition.Builder |
|
clone()
public ReportTask.ReportDefinition.Builder clone()| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
getCohortSpec()
public 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. |
getCohortSpecBuilder()
public CohortSpec.Builder getCohortSpecBuilder()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.Builder |
|
getCohortSpecOrBuilder()
public 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 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 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 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 |
|
getDateRangesBuilder(int index)
public DateRange.Builder getDateRangesBuilder(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.Builder |
|
getDateRangesBuilderList()
public List<DateRange.Builder> getDateRangesBuilderList() 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<Builder> |
|
getDateRangesCount()
public 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 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 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 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> |
|
getDefaultInstanceForType()
public ReportTask.ReportDefinition getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDimensionFilter()
public 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. |
getDimensionFilterBuilder()
public FilterExpression.Builder getDimensionFilterBuilder()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.Builder |
|
getDimensionFilterOrBuilder()
public 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 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 |
|
getDimensionsBuilder(int index)
public Dimension.Builder getDimensionsBuilder(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.Builder |
|
getDimensionsBuilderList()
public List<Dimension.Builder> getDimensionsBuilderList()Optional. The dimensions requested and displayed.
repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getDimensionsCount()
public 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 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 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 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 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 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 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 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 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 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 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 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. |
getMetricFilterBuilder()
public FilterExpression.Builder getMetricFilterBuilder()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.Builder |
|
getMetricFilterOrBuilder()
public 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 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 |
|
getMetricsBuilder(int index)
public Metric.Builder getMetricsBuilder(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.Builder |
|
getMetricsBuilderList()
public List<Metric.Builder> getMetricsBuilderList()Optional. The metrics requested and displayed.
repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getMetricsCount()
public 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 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 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 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 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 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 |
|
getOrderBysBuilder(int index)
public OrderBy.Builder getOrderBysBuilder(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.Builder |
|
getOrderBysBuilderList()
public List<OrderBy.Builder> getOrderBysBuilderList()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<Builder> |
|
getOrderBysCount()
public 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCohortSpec(CohortSpec value)
public ReportTask.ReportDefinition.Builder mergeCohortSpec(CohortSpec value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CohortSpec |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
mergeDimensionFilter(FilterExpression value)
public ReportTask.ReportDefinition.Builder mergeDimensionFilter(FilterExpression value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
FilterExpression |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
mergeFrom(ReportTask.ReportDefinition other)
public ReportTask.ReportDefinition.Builder mergeFrom(ReportTask.ReportDefinition other)| Parameter | |
|---|---|
| Name | Description |
other |
ReportTask.ReportDefinition |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ReportTask.ReportDefinition.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ReportTask.ReportDefinition.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
mergeMetricFilter(FilterExpression value)
public ReportTask.ReportDefinition.Builder mergeMetricFilter(FilterExpression value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
FilterExpression |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ReportTask.ReportDefinition.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
removeDateRanges(int index)
public ReportTask.ReportDefinition.Builder removeDateRanges(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 |
ReportTask.ReportDefinition.Builder |
|
removeDimensions(int index)
public ReportTask.ReportDefinition.Builder removeDimensions(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 |
ReportTask.ReportDefinition.Builder |
|
removeMetrics(int index)
public ReportTask.ReportDefinition.Builder removeMetrics(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 |
ReportTask.ReportDefinition.Builder |
|
removeOrderBys(int index)
public ReportTask.ReportDefinition.Builder removeOrderBys(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 |
ReportTask.ReportDefinition.Builder |
|
setCohortSpec(CohortSpec value)
public ReportTask.ReportDefinition.Builder setCohortSpec(CohortSpec value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CohortSpec |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setCohortSpec(CohortSpec.Builder builderForValue)
public ReportTask.ReportDefinition.Builder setCohortSpec(CohortSpec.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CohortSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setCurrencyCode(String value)
public ReportTask.ReportDefinition.Builder setCurrencyCode(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe currencyCode to set. |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
setCurrencyCodeBytes(ByteString value)
public ReportTask.ReportDefinition.Builder setCurrencyCodeBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for currencyCode to set. |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
setDateRanges(int index, DateRange value)
public ReportTask.ReportDefinition.Builder setDateRanges(int index, DateRange value) 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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
DateRange |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setDateRanges(int index, DateRange.Builder builderForValue)
public ReportTask.ReportDefinition.Builder setDateRanges(int index, DateRange.Builder builderForValue) 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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
DateRange.Builder |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setDimensionFilter(FilterExpression value)
public ReportTask.ReportDefinition.Builder setDimensionFilter(FilterExpression value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
FilterExpression |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setDimensionFilter(FilterExpression.Builder builderForValue)
public ReportTask.ReportDefinition.Builder setDimensionFilter(FilterExpression.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
FilterExpression.Builder |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setDimensions(int index, Dimension value)
public ReportTask.ReportDefinition.Builder setDimensions(int index, Dimension value)Optional. The dimensions requested and displayed.
repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Dimension |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setDimensions(int index, Dimension.Builder builderForValue)
public ReportTask.ReportDefinition.Builder setDimensions(int index, Dimension.Builder builderForValue)Optional. The dimensions requested and displayed.
repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Dimension.Builder |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ReportTask.ReportDefinition.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setKeepEmptyRows(boolean value)
public ReportTask.ReportDefinition.Builder setKeepEmptyRows(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe keepEmptyRows to set. |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
setLimit(long value)
public ReportTask.ReportDefinition.Builder setLimit(long value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe limit to set. |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
setMetricAggregations(int index, MetricAggregation value)
public ReportTask.ReportDefinition.Builder setMetricAggregations(int index, MetricAggregation value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
MetricAggregationThe metricAggregations to set. |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
setMetricAggregationsValue(int index, int value)
public ReportTask.ReportDefinition.Builder setMetricAggregationsValue(int index, int value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe enum numeric value on the wire for metricAggregations to set. |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
setMetricFilter(FilterExpression value)
public ReportTask.ReportDefinition.Builder setMetricFilter(FilterExpression value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
FilterExpression |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setMetricFilter(FilterExpression.Builder builderForValue)
public ReportTask.ReportDefinition.Builder setMetricFilter(FilterExpression.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
FilterExpression.Builder |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setMetrics(int index, Metric value)
public ReportTask.ReportDefinition.Builder setMetrics(int index, Metric value)Optional. The metrics requested and displayed.
repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Metric |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setMetrics(int index, Metric.Builder builderForValue)
public ReportTask.ReportDefinition.Builder setMetrics(int index, Metric.Builder builderForValue)Optional. The metrics requested and displayed.
repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Metric.Builder |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setOffset(long value)
public ReportTask.ReportDefinition.Builder setOffset(long value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe offset to set. |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
This builder for chaining. |
setOrderBys(int index, OrderBy value)
public ReportTask.ReportDefinition.Builder setOrderBys(int index, OrderBy value)Optional. Specifies how rows are ordered in the response.
repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
OrderBy |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setOrderBys(int index, OrderBy.Builder builderForValue)
public ReportTask.ReportDefinition.Builder setOrderBys(int index, OrderBy.Builder builderForValue)Optional. Specifies how rows are ordered in the response.
repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
OrderBy.Builder |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ReportTask.ReportDefinition.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ReportTask.ReportDefinition.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ReportTask.ReportDefinition.Builder |
|