Class RunReportRequest.Builder (0.64.0)

public static final class RunReportRequest.Builder extends GeneratedMessageV3.Builder<RunReportRequest.Builder> implements RunReportRequestOrBuilder

The request to generate a report.

Protobuf type google.analytics.data.v1beta.RunReportRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RunReportRequest.Builder

Implements

RunReportRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllComparisons(Iterable<? extends Comparison> values)

public RunReportRequest.Builder addAllComparisons(Iterable<? extends Comparison> values)

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`values`	`Iterable<? extends com.google.analytics.data.v1beta.Comparison>`

Returns
Type	Description
`RunReportRequest.Builder`

addAllDateRanges(Iterable<? extends DateRange> values)

public RunReportRequest.Builder addAllDateRanges(Iterable<? extends DateRange> values)

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.v1beta.DateRange date_ranges = 4;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.analytics.data.v1beta.DateRange>`

Returns
Type	Description
`RunReportRequest.Builder`

addAllDimensions(Iterable<? extends Dimension> values)

public RunReportRequest.Builder addAllDimensions(Iterable<? extends Dimension> values)

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.analytics.data.v1beta.Dimension>`

Returns
Type	Description
`RunReportRequest.Builder`

addAllMetricAggregations(Iterable<? extends MetricAggregation> values)

public RunReportRequest.Builder addAllMetricAggregations(Iterable<? extends MetricAggregation> values)

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 9;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.analytics.data.v1beta.MetricAggregation>` The metricAggregations to add.

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

addAllMetricAggregationsValue(Iterable<Integer> values)

public RunReportRequest.Builder addAllMetricAggregationsValue(Iterable<Integer> values)

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 9;

Parameter
Name	Description
`values`	`Iterable<Integer>` The enum numeric values on the wire for metricAggregations to add.

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

addAllMetrics(Iterable<? extends Metric> values)

public RunReportRequest.Builder addAllMetrics(Iterable<? extends Metric> values)

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.analytics.data.v1beta.Metric>`

Returns
Type	Description
`RunReportRequest.Builder`

addAllOrderBys(Iterable<? extends OrderBy> values)

public RunReportRequest.Builder addAllOrderBys(Iterable<? extends OrderBy> values)

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.analytics.data.v1beta.OrderBy>`

Returns
Type	Description
`RunReportRequest.Builder`

addComparisons(Comparison value)

public RunReportRequest.Builder addComparisons(Comparison value)

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Comparison`

Returns
Type	Description
`RunReportRequest.Builder`

addComparisons(Comparison.Builder builderForValue)

public RunReportRequest.Builder addComparisons(Comparison.Builder builderForValue)

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`Comparison.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

addComparisons(int index, Comparison value)

public RunReportRequest.Builder addComparisons(int index, Comparison value)

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`value`	`Comparison`

Returns
Type	Description
`RunReportRequest.Builder`

addComparisons(int index, Comparison.Builder builderForValue)

public RunReportRequest.Builder addComparisons(int index, Comparison.Builder builderForValue)

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Comparison.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

addComparisonsBuilder()

public Comparison.Builder addComparisonsBuilder()

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Comparison.Builder`

addComparisonsBuilder(int index)

public Comparison.Builder addComparisonsBuilder(int index)

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Comparison.Builder`

addDateRanges(DateRange value)

public RunReportRequest.Builder addDateRanges(DateRange value)

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Parameter
Name	Description
`value`	`DateRange`

Returns
Type	Description
`RunReportRequest.Builder`

addDateRanges(DateRange.Builder builderForValue)

public RunReportRequest.Builder addDateRanges(DateRange.Builder builderForValue)

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Parameter
Name	Description
`builderForValue`	`DateRange.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

addDateRanges(int index, DateRange value)

public RunReportRequest.Builder addDateRanges(int index, DateRange value)

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Parameters
Name	Description
`index`	`int`
`value`	`DateRange`

Returns
Type	Description
`RunReportRequest.Builder`

addDateRanges(int index, DateRange.Builder builderForValue)

public RunReportRequest.Builder addDateRanges(int index, DateRange.Builder builderForValue)

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`DateRange.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

addDateRangesBuilder()

public DateRange.Builder addDateRangesBuilder()

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Returns
Type	Description
`DateRange.Builder`

addDateRangesBuilder(int index)

public DateRange.Builder addDateRangesBuilder(int index)

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DateRange.Builder`

addDimensions(Dimension value)

public RunReportRequest.Builder addDimensions(Dimension value)

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Parameter
Name	Description
`value`	`Dimension`

Returns
Type	Description
`RunReportRequest.Builder`

addDimensions(Dimension.Builder builderForValue)

public RunReportRequest.Builder addDimensions(Dimension.Builder builderForValue)

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Parameter
Name	Description
`builderForValue`	`Dimension.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

addDimensions(int index, Dimension value)

public RunReportRequest.Builder addDimensions(int index, Dimension value)

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Parameters
Name	Description
`index`	`int`
`value`	`Dimension`

Returns
Type	Description
`RunReportRequest.Builder`

addDimensions(int index, Dimension.Builder builderForValue)

public RunReportRequest.Builder addDimensions(int index, Dimension.Builder builderForValue)

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Dimension.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

addDimensionsBuilder()

public Dimension.Builder addDimensionsBuilder()

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Returns
Type	Description
`Dimension.Builder`

addDimensionsBuilder(int index)

public Dimension.Builder addDimensionsBuilder(int index)

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Dimension.Builder`

addMetricAggregations(MetricAggregation value)

public RunReportRequest.Builder addMetricAggregations(MetricAggregation value)

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 9;

Parameter
Name	Description
`value`	`MetricAggregation` The metricAggregations to add.

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

addMetricAggregationsValue(int value)

public RunReportRequest.Builder addMetricAggregationsValue(int value)

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 9;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for metricAggregations to add.

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

addMetrics(Metric value)

public RunReportRequest.Builder addMetrics(Metric value)

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Parameter
Name	Description
`value`	`Metric`

Returns
Type	Description
`RunReportRequest.Builder`

addMetrics(Metric.Builder builderForValue)

public RunReportRequest.Builder addMetrics(Metric.Builder builderForValue)

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Parameter
Name	Description
`builderForValue`	`Metric.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

addMetrics(int index, Metric value)

public RunReportRequest.Builder addMetrics(int index, Metric value)

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Parameters
Name	Description
`index`	`int`
`value`	`Metric`

Returns
Type	Description
`RunReportRequest.Builder`

addMetrics(int index, Metric.Builder builderForValue)

public RunReportRequest.Builder addMetrics(int index, Metric.Builder builderForValue)

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Metric.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

addMetricsBuilder()

public Metric.Builder addMetricsBuilder()

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Returns
Type	Description
`Metric.Builder`

addMetricsBuilder(int index)

public Metric.Builder addMetricsBuilder(int index)

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Metric.Builder`

addOrderBys(OrderBy value)

public RunReportRequest.Builder addOrderBys(OrderBy value)

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Parameter
Name	Description
`value`	`OrderBy`

Returns
Type	Description
`RunReportRequest.Builder`

addOrderBys(OrderBy.Builder builderForValue)

public RunReportRequest.Builder addOrderBys(OrderBy.Builder builderForValue)

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Parameter
Name	Description
`builderForValue`	`OrderBy.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

addOrderBys(int index, OrderBy value)

public RunReportRequest.Builder addOrderBys(int index, OrderBy value)

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Parameters
Name	Description
`index`	`int`
`value`	`OrderBy`

Returns
Type	Description
`RunReportRequest.Builder`

addOrderBys(int index, OrderBy.Builder builderForValue)

public RunReportRequest.Builder addOrderBys(int index, OrderBy.Builder builderForValue)

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`OrderBy.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

addOrderBysBuilder()

public OrderBy.Builder addOrderBysBuilder()

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Returns
Type	Description
`OrderBy.Builder`

addOrderBysBuilder(int index)

public OrderBy.Builder addOrderBysBuilder(int index)

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`OrderBy.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunReportRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`RunReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public RunReportRequest build()

Returns
Type	Description
`RunReportRequest`

buildPartial()

public RunReportRequest buildPartial()

Returns
Type	Description
`RunReportRequest`

clear()

public RunReportRequest.Builder clear()

Returns
Type	Description
`RunReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCohortSpec()

public RunReportRequest.Builder clearCohortSpec()

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 = 12;

Returns
Type	Description
`RunReportRequest.Builder`

clearComparisons()

public RunReportRequest.Builder clearComparisons()

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`RunReportRequest.Builder`

clearCurrencyCode()

public RunReportRequest.Builder clearCurrencyCode()

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;

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

clearDateRanges()

public RunReportRequest.Builder clearDateRanges()

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Returns
Type	Description
`RunReportRequest.Builder`

clearDimensionFilter()

public RunReportRequest.Builder clearDimensionFilter()

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.v1beta.FilterExpression dimension_filter = 5;

Returns
Type	Description
`RunReportRequest.Builder`

clearDimensions()

public RunReportRequest.Builder clearDimensions()

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Returns
Type	Description
`RunReportRequest.Builder`

clearField(Descriptors.FieldDescriptor field)

public RunReportRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`RunReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearKeepEmptyRows()

public RunReportRequest.Builder clearKeepEmptyRows()

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 = 13;

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

clearLimit()

public RunReportRequest.Builder clearLimit()

The number of rows to return. 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.

To learn more about this pagination parameter, see Pagination.

int64 limit = 8;

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

clearMetricAggregations()

public RunReportRequest.Builder clearMetricAggregations()

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 9;

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

clearMetricFilter()

public RunReportRequest.Builder clearMetricFilter()

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.v1beta.FilterExpression metric_filter = 6;

Returns
Type	Description
`RunReportRequest.Builder`

clearMetrics()

public RunReportRequest.Builder clearMetrics()

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Returns
Type	Description
`RunReportRequest.Builder`

clearOffset()

public RunReportRequest.Builder clearOffset()

The row count of the start row. The first row is counted as row 0.

When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows.

To learn more about this pagination parameter, see Pagination.

int64 offset = 7;

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RunReportRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`RunReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOrderBys()

public RunReportRequest.Builder clearOrderBys()

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Returns
Type	Description
`RunReportRequest.Builder`

clearProperty()

public RunReportRequest.Builder clearProperty()

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
`RunReportRequest.Builder`	This builder for chaining.

clearReturnPropertyQuota()

public RunReportRequest.Builder clearReturnPropertyQuota()

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

bool return_property_quota = 14;

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

clone()

public RunReportRequest.Builder clone()

Returns
Type	Description
`RunReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCohortSpec()

public 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 = 12;

Returns
Type	Description
`CohortSpec`	The cohortSpec.

getCohortSpecBuilder()

public CohortSpec.Builder getCohortSpecBuilder()

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 = 12;

Returns
Type	Description
`CohortSpec.Builder`

getCohortSpecOrBuilder()

public 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 = 12;

Returns
Type	Description
`CohortSpecOrBuilder`

getComparisons(int index)

public Comparison getComparisons(int index)

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Comparison`

getComparisonsBuilder(int index)

public Comparison.Builder getComparisonsBuilder(int index)

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Comparison.Builder`

getComparisonsBuilderList()

public List<Comparison.Builder> getComparisonsBuilderList()

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Builder>`

getComparisonsCount()

public int getComparisonsCount()

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getComparisonsList()

public List<Comparison> getComparisonsList()

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Comparison>`

getComparisonsOrBuilder(int index)

public ComparisonOrBuilder getComparisonsOrBuilder(int index)

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ComparisonOrBuilder`

getComparisonsOrBuilderList()

public List<? extends ComparisonOrBuilder> getComparisonsOrBuilderList()

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.analytics.data.v1beta.ComparisonOrBuilder>`

getCurrencyCode()

public 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 = 11;

Returns
Type	Description
`String`	The currencyCode.

getCurrencyCodeBytes()

public 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 = 11;

Returns
Type	Description
`ByteString`	The bytes for currencyCode.

getDateRanges(int index)

public DateRange getDateRanges(int index)

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DateRange`

getDateRangesBuilder(int index)

public DateRange.Builder getDateRangesBuilder(int index)

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DateRange.Builder`

getDateRangesBuilderList()

public List<DateRange.Builder> getDateRangesBuilderList()

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Returns
Type	Description
`List<Builder>`

getDateRangesCount()

public int getDateRangesCount()

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Returns
Type	Description
`int`

getDateRangesList()

public List<DateRange> getDateRangesList()

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Returns
Type	Description
`List<DateRange>`

getDateRangesOrBuilder(int index)

public DateRangeOrBuilder getDateRangesOrBuilder(int index)

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DateRangeOrBuilder`

getDateRangesOrBuilderList()

public List<? extends DateRangeOrBuilder> getDateRangesOrBuilderList()

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Returns
Type	Description
`List<? extends com.google.analytics.data.v1beta.DateRangeOrBuilder>`

getDefaultInstanceForType()

public RunReportRequest getDefaultInstanceForType()

Returns
Type	Description
`RunReportRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDimensionFilter()

public FilterExpression getDimensionFilter()

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.v1beta.FilterExpression dimension_filter = 5;

Returns
Type	Description
`FilterExpression`	The dimensionFilter.

getDimensionFilterBuilder()

public FilterExpression.Builder getDimensionFilterBuilder()

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.v1beta.FilterExpression dimension_filter = 5;

Returns
Type	Description
`FilterExpression.Builder`

getDimensionFilterOrBuilder()

public FilterExpressionOrBuilder getDimensionFilterOrBuilder()

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.v1beta.FilterExpression dimension_filter = 5;

Returns
Type	Description
`FilterExpressionOrBuilder`

getDimensions(int index)

public Dimension getDimensions(int index)

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Dimension`

getDimensionsBuilder(int index)

public Dimension.Builder getDimensionsBuilder(int index)

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Dimension.Builder`

getDimensionsBuilderList()

public List<Dimension.Builder> getDimensionsBuilderList()

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Returns
Type	Description
`List<Builder>`

getDimensionsCount()

public int getDimensionsCount()

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Returns
Type	Description
`int`

getDimensionsList()

public List<Dimension> getDimensionsList()

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Returns
Type	Description
`List<Dimension>`

getDimensionsOrBuilder(int index)

public DimensionOrBuilder getDimensionsOrBuilder(int index)

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DimensionOrBuilder`

getDimensionsOrBuilderList()

public List<? extends DimensionOrBuilder> getDimensionsOrBuilderList()

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Returns
Type	Description
`List<? extends com.google.analytics.data.v1beta.DimensionOrBuilder>`

getKeepEmptyRows()

public 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 = 13;

Returns
Type	Description
`boolean`	The keepEmptyRows.

getLimit()

public long getLimit()

The number of rows to return. 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.

To learn more about this pagination parameter, see Pagination.

int64 limit = 8;

Returns
Type	Description
`long`	The limit.

getMetricAggregations(int index)

public MetricAggregation getMetricAggregations(int index)

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 9;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`MetricAggregation`	The metricAggregations at the given index.

getMetricAggregationsCount()

public int getMetricAggregationsCount()

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 9;

Returns
Type	Description
`int`	The count of metricAggregations.

getMetricAggregationsList()

public List<MetricAggregation> getMetricAggregationsList()

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 9;

Returns
Type	Description
`List<MetricAggregation>`	A list containing the metricAggregations.

getMetricAggregationsValue(int index)

public int getMetricAggregationsValue(int index)

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 9;

Parameter
Name	Description
`index`	`int` The 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()

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 9;

Returns
Type	Description
`List<Integer>`	A list containing the enum numeric values on the wire for metricAggregations.

getMetricFilter()

public FilterExpression getMetricFilter()

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.v1beta.FilterExpression metric_filter = 6;

Returns
Type	Description
`FilterExpression`	The metricFilter.

getMetricFilterBuilder()

public FilterExpression.Builder getMetricFilterBuilder()

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.v1beta.FilterExpression metric_filter = 6;

Returns
Type	Description
`FilterExpression.Builder`

getMetricFilterOrBuilder()

public FilterExpressionOrBuilder getMetricFilterOrBuilder()

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.v1beta.FilterExpression metric_filter = 6;

Returns
Type	Description
`FilterExpressionOrBuilder`

getMetrics(int index)

public Metric getMetrics(int index)

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Metric`

getMetricsBuilder(int index)

public Metric.Builder getMetricsBuilder(int index)

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Metric.Builder`

getMetricsBuilderList()

public List<Metric.Builder> getMetricsBuilderList()

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Returns
Type	Description
`List<Builder>`

getMetricsCount()

public int getMetricsCount()

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Returns
Type	Description
`int`

getMetricsList()

public List<Metric> getMetricsList()

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Returns
Type	Description
`List<Metric>`

getMetricsOrBuilder(int index)

public MetricOrBuilder getMetricsOrBuilder(int index)

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`MetricOrBuilder`

getMetricsOrBuilderList()

public List<? extends MetricOrBuilder> getMetricsOrBuilderList()

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Returns
Type	Description
`List<? extends com.google.analytics.data.v1beta.MetricOrBuilder>`

getOffset()

public long getOffset()

The row count of the start row. The first row is counted as row 0.

To learn more about this pagination parameter, see Pagination.

int64 offset = 7;

Returns
Type	Description
`long`	The offset.

getOrderBys(int index)

public OrderBy getOrderBys(int index)

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`OrderBy`

getOrderBysBuilder(int index)

public OrderBy.Builder getOrderBysBuilder(int index)

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`OrderBy.Builder`

getOrderBysBuilderList()

public List<OrderBy.Builder> getOrderBysBuilderList()

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Returns
Type	Description
`List<Builder>`

getOrderBysCount()

public int getOrderBysCount()

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Returns
Type	Description
`int`

getOrderBysList()

public List<OrderBy> getOrderBysList()

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Returns
Type	Description
`List<OrderBy>`

getOrderBysOrBuilder(int index)

public OrderByOrBuilder getOrderBysOrBuilder(int index)

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`OrderByOrBuilder`

getOrderBysOrBuilderList()

public List<? extends OrderByOrBuilder> getOrderBysOrBuilderList()

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Returns
Type	Description
`List<? extends com.google.analytics.data.v1beta.OrderByOrBuilder>`

getProperty()

public String getProperty()

Example: properties/1234

string property = 1;

Returns
Type	Description
`String`	The property.

getPropertyBytes()

public ByteString getPropertyBytes()

Example: properties/1234

string property = 1;

Returns
Type	Description
`ByteString`	The bytes for property.

getReturnPropertyQuota()

public boolean getReturnPropertyQuota()

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

bool return_property_quota = 14;

Returns
Type	Description
`boolean`	The returnPropertyQuota.

hasCohortSpec()

public 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 = 12;

Returns
Type	Description
`boolean`	Whether the cohortSpec field is set.

hasDimensionFilter()

public boolean hasDimensionFilter()

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.v1beta.FilterExpression dimension_filter = 5;

Returns
Type	Description
`boolean`	Whether the dimensionFilter field is set.

hasMetricFilter()

public boolean hasMetricFilter()

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.v1beta.FilterExpression metric_filter = 6;

Returns
Type	Description
`boolean`	Whether the metricFilter field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCohortSpec(CohortSpec value)

public RunReportRequest.Builder mergeCohortSpec(CohortSpec value)

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 = 12;

Parameter
Name	Description
`value`	`CohortSpec`

Returns
Type	Description
`RunReportRequest.Builder`

mergeDimensionFilter(FilterExpression value)

public RunReportRequest.Builder mergeDimensionFilter(FilterExpression value)

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.v1beta.FilterExpression dimension_filter = 5;

Parameter
Name	Description
`value`	`FilterExpression`

Returns
Type	Description
`RunReportRequest.Builder`

mergeFrom(RunReportRequest other)

public RunReportRequest.Builder mergeFrom(RunReportRequest other)

Parameter
Name	Description
`other`	`RunReportRequest`

Returns
Type	Description
`RunReportRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunReportRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RunReportRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public RunReportRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`RunReportRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeMetricFilter(FilterExpression value)

public RunReportRequest.Builder mergeMetricFilter(FilterExpression value)

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.v1beta.FilterExpression metric_filter = 6;

Parameter
Name	Description
`value`	`FilterExpression`

Returns
Type	Description
`RunReportRequest.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunReportRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`RunReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeComparisons(int index)

public RunReportRequest.Builder removeComparisons(int index)

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`RunReportRequest.Builder`

removeDateRanges(int index)

public RunReportRequest.Builder removeDateRanges(int index)

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`RunReportRequest.Builder`

removeDimensions(int index)

public RunReportRequest.Builder removeDimensions(int index)

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`RunReportRequest.Builder`

removeMetrics(int index)

public RunReportRequest.Builder removeMetrics(int index)

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`RunReportRequest.Builder`

removeOrderBys(int index)

public RunReportRequest.Builder removeOrderBys(int index)

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`RunReportRequest.Builder`

setCohortSpec(CohortSpec value)

public RunReportRequest.Builder setCohortSpec(CohortSpec value)

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 = 12;

Parameter
Name	Description
`value`	`CohortSpec`

Returns
Type	Description
`RunReportRequest.Builder`

setCohortSpec(CohortSpec.Builder builderForValue)

public RunReportRequest.Builder setCohortSpec(CohortSpec.Builder builderForValue)

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 = 12;

Parameter
Name	Description
`builderForValue`	`CohortSpec.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

setComparisons(int index, Comparison value)

public RunReportRequest.Builder setComparisons(int index, Comparison value)

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`value`	`Comparison`

Returns
Type	Description
`RunReportRequest.Builder`

setComparisons(int index, Comparison.Builder builderForValue)

public RunReportRequest.Builder setComparisons(int index, Comparison.Builder builderForValue)

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Comparison.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

setCurrencyCode(String value)

public RunReportRequest.Builder setCurrencyCode(String value)

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;

Parameter
Name	Description
`value`	`String` The currencyCode to set.

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

setCurrencyCodeBytes(ByteString value)

public RunReportRequest.Builder setCurrencyCodeBytes(ByteString value)

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;

Parameter
Name	Description
`value`	`ByteString` The bytes for currencyCode to set.

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

setDateRanges(int index, DateRange value)

public RunReportRequest.Builder setDateRanges(int index, DateRange value)

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Parameters
Name	Description
`index`	`int`
`value`	`DateRange`

Returns
Type	Description
`RunReportRequest.Builder`

setDateRanges(int index, DateRange.Builder builderForValue)

public RunReportRequest.Builder setDateRanges(int index, DateRange.Builder builderForValue)

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`DateRange.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

setDimensionFilter(FilterExpression value)

public RunReportRequest.Builder setDimensionFilter(FilterExpression value)

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.v1beta.FilterExpression dimension_filter = 5;

Parameter
Name	Description
`value`	`FilterExpression`

Returns
Type	Description
`RunReportRequest.Builder`

setDimensionFilter(FilterExpression.Builder builderForValue)

public RunReportRequest.Builder setDimensionFilter(FilterExpression.Builder builderForValue)

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.v1beta.FilterExpression dimension_filter = 5;

Parameter
Name	Description
`builderForValue`	`FilterExpression.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

setDimensions(int index, Dimension value)

public RunReportRequest.Builder setDimensions(int index, Dimension value)

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Parameters
Name	Description
`index`	`int`
`value`	`Dimension`

Returns
Type	Description
`RunReportRequest.Builder`

setDimensions(int index, Dimension.Builder builderForValue)

public RunReportRequest.Builder setDimensions(int index, Dimension.Builder builderForValue)

The dimensions requested and displayed.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Dimension.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public RunReportRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`RunReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setKeepEmptyRows(boolean value)

public RunReportRequest.Builder setKeepEmptyRows(boolean value)

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 = 13;

Parameter
Name	Description
`value`	`boolean` The keepEmptyRows to set.

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

setLimit(long value)

public RunReportRequest.Builder setLimit(long value)

The number of rows to return. 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.

To learn more about this pagination parameter, see Pagination.

int64 limit = 8;

Parameter
Name	Description
`value`	`long` The limit to set.

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

setMetricAggregations(int index, MetricAggregation value)

public RunReportRequest.Builder setMetricAggregations(int index, MetricAggregation value)

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 9;

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`MetricAggregation` The metricAggregations to set.

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

setMetricAggregationsValue(int index, int value)

public RunReportRequest.Builder setMetricAggregationsValue(int index, int value)

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 9;

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`int` The enum numeric value on the wire for metricAggregations to set.

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

setMetricFilter(FilterExpression value)

public RunReportRequest.Builder setMetricFilter(FilterExpression value)

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.v1beta.FilterExpression metric_filter = 6;

Parameter
Name	Description
`value`	`FilterExpression`

Returns
Type	Description
`RunReportRequest.Builder`

setMetricFilter(FilterExpression.Builder builderForValue)

public RunReportRequest.Builder setMetricFilter(FilterExpression.Builder builderForValue)

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.v1beta.FilterExpression metric_filter = 6;

Parameter
Name	Description
`builderForValue`	`FilterExpression.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

setMetrics(int index, Metric value)

public RunReportRequest.Builder setMetrics(int index, Metric value)

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Parameters
Name	Description
`index`	`int`
`value`	`Metric`

Returns
Type	Description
`RunReportRequest.Builder`

setMetrics(int index, Metric.Builder builderForValue)

public RunReportRequest.Builder setMetrics(int index, Metric.Builder builderForValue)

The metrics requested and displayed.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Metric.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

setOffset(long value)

public RunReportRequest.Builder setOffset(long value)

The row count of the start row. The first row is counted as row 0.

To learn more about this pagination parameter, see Pagination.

int64 offset = 7;

Parameter
Name	Description
`value`	`long` The offset to set.

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

setOrderBys(int index, OrderBy value)

public RunReportRequest.Builder setOrderBys(int index, OrderBy value)

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Parameters
Name	Description
`index`	`int`
`value`	`OrderBy`

Returns
Type	Description
`RunReportRequest.Builder`

setOrderBys(int index, OrderBy.Builder builderForValue)

public RunReportRequest.Builder setOrderBys(int index, OrderBy.Builder builderForValue)

Specifies how rows are ordered in the response.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 10;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`OrderBy.Builder`

Returns
Type	Description
`RunReportRequest.Builder`

setProperty(String value)

public RunReportRequest.Builder setProperty(String value)

Example: properties/1234

string property = 1;

Parameter
Name	Description
`value`	`String` The property to set.

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

setPropertyBytes(ByteString value)

public RunReportRequest.Builder setPropertyBytes(ByteString value)

Example: properties/1234

string property = 1;

Parameter
Name	Description
`value`	`ByteString` The bytes for property to set.

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RunReportRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`RunReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setReturnPropertyQuota(boolean value)

public RunReportRequest.Builder setReturnPropertyQuota(boolean value)

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

bool return_property_quota = 14;

Parameter
Name	Description
`value`	`boolean` The returnPropertyQuota to set.

Returns
Type	Description
`RunReportRequest.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RunReportRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`RunReportRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)