Class RunReportRequest.Builder (0.18.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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

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
NameDescription
valuesIterable<? extends com.google.analytics.data.v1beta.DateRange>
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.analytics.data.v1beta.Dimension>
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.analytics.data.v1beta.MetricAggregation>

The metricAggregations to add.

Returns
TypeDescription
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
NameDescription
valuesIterable<Integer>

The enum numeric values on the wire for metricAggregations to add.

Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.analytics.data.v1beta.Metric>
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.analytics.data.v1beta.OrderBy>
Returns
TypeDescription
RunReportRequest.Builder

addDateRanges(DateRange value)

public RunReportRequest.Builder addDateRanges(DateRange value)

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
NameDescription
valueDateRange
Returns
TypeDescription
RunReportRequest.Builder

addDateRanges(DateRange.Builder builderForValue)

public RunReportRequest.Builder addDateRanges(DateRange.Builder builderForValue)

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
NameDescription
builderForValueDateRange.Builder
Returns
TypeDescription
RunReportRequest.Builder

addDateRanges(int index, DateRange value)

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

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;

Parameters
NameDescription
indexint
valueDateRange
Returns
TypeDescription
RunReportRequest.Builder

addDateRanges(int index, DateRange.Builder builderForValue)

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

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;

Parameters
NameDescription
indexint
builderForValueDateRange.Builder
Returns
TypeDescription
RunReportRequest.Builder

addDateRangesBuilder()

public DateRange.Builder addDateRangesBuilder()

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;

Returns
TypeDescription
DateRange.Builder

addDateRangesBuilder(int index)

public DateRange.Builder addDateRangesBuilder(int index)

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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valueDimension
Returns
TypeDescription
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
NameDescription
builderForValueDimension.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueDimension
Returns
TypeDescription
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
NameDescription
indexint
builderForValueDimension.Builder
Returns
TypeDescription
RunReportRequest.Builder

addDimensionsBuilder()

public Dimension.Builder addDimensionsBuilder()

The dimensions requested and displayed.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valueMetricAggregation

The metricAggregations to add.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for metricAggregations to add.

Returns
TypeDescription
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
NameDescription
valueMetric
Returns
TypeDescription
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
NameDescription
builderForValueMetric.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueMetric
Returns
TypeDescription
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
NameDescription
indexint
builderForValueMetric.Builder
Returns
TypeDescription
RunReportRequest.Builder

addMetricsBuilder()

public Metric.Builder addMetricsBuilder()

The metrics requested and displayed.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valueOrderBy
Returns
TypeDescription
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
NameDescription
builderForValueOrderBy.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueOrderBy
Returns
TypeDescription
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
NameDescription
indexint
builderForValueOrderBy.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
OrderBy.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunReportRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RunReportRequest.Builder
Overrides

build()

public RunReportRequest build()
Returns
TypeDescription
RunReportRequest

buildPartial()

public RunReportRequest buildPartial()
Returns
TypeDescription
RunReportRequest

clear()

public RunReportRequest.Builder clear()
Returns
TypeDescription
RunReportRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
RunReportRequest.Builder

This builder for chaining.

clearDateRanges()

public RunReportRequest.Builder clearDateRanges()

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;

Returns
TypeDescription
RunReportRequest.Builder

clearDimensionFilter()

public RunReportRequest.Builder clearDimensionFilter()

Dimension filters allow you to 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
TypeDescription
RunReportRequest.Builder

clearDimensions()

public RunReportRequest.Builder clearDimensions()

The dimensions requested and displayed.

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

Returns
TypeDescription
RunReportRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public RunReportRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RunReportRequest.Builder
Overrides

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.

bool keep_empty_rows = 13;

Returns
TypeDescription
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 100,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
TypeDescription
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
TypeDescription
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
TypeDescription
RunReportRequest.Builder

clearMetrics()

public RunReportRequest.Builder clearMetrics()

The metrics requested and displayed.

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

Returns
TypeDescription
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
TypeDescription
RunReportRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RunReportRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
RunReportRequest.Builder
Overrides

clearOrderBys()

public RunReportRequest.Builder clearOrderBys()

Specifies how rows are ordered in the response.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
RunReportRequest.Builder

This builder for chaining.

clone()

public RunReportRequest.Builder clone()
Returns
TypeDescription
RunReportRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
CohortSpecOrBuilder

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
TypeDescription
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
TypeDescription
ByteString

The bytes for currencyCode.

getDateRanges(int index)

public DateRange getDateRanges(int index)

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
NameDescription
indexint
Returns
TypeDescription
DateRange

getDateRangesBuilder(int index)

public DateRange.Builder getDateRangesBuilder(int index)

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
NameDescription
indexint
Returns
TypeDescription
DateRange.Builder

getDateRangesBuilderList()

public List<DateRange.Builder> getDateRangesBuilderList()

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;

Returns
TypeDescription
List<Builder>

getDateRangesCount()

public int getDateRangesCount()

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;

Returns
TypeDescription
int

getDateRangesList()

public List<DateRange> getDateRangesList()

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;

Returns
TypeDescription
List<DateRange>

getDateRangesOrBuilder(int index)

public DateRangeOrBuilder getDateRangesOrBuilder(int index)

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
NameDescription
indexint
Returns
TypeDescription
DateRangeOrBuilder

getDateRangesOrBuilderList()

public List<? extends DateRangeOrBuilder> getDateRangesOrBuilderList()

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;

Returns
TypeDescription
List<? extends com.google.analytics.data.v1beta.DateRangeOrBuilder>

getDefaultInstanceForType()

public RunReportRequest getDefaultInstanceForType()
Returns
TypeDescription
RunReportRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDimensionFilter()

public FilterExpression getDimensionFilter()

Dimension filters allow you to 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
TypeDescription
FilterExpression

The dimensionFilter.

getDimensionFilterBuilder()

public FilterExpression.Builder getDimensionFilterBuilder()

Dimension filters allow you to 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
TypeDescription
FilterExpression.Builder

getDimensionFilterOrBuilder()

public FilterExpressionOrBuilder getDimensionFilterOrBuilder()

Dimension filters allow you to 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
TypeDescription
FilterExpressionOrBuilder

getDimensions(int index)

public Dimension getDimensions(int index)

The dimensions requested and displayed.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Dimension

getDimensionsBuilder(int index)

public Dimension.Builder getDimensionsBuilder(int index)

The dimensions requested and displayed.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Dimension.Builder

getDimensionsBuilderList()

public List<Dimension.Builder> getDimensionsBuilderList()

The dimensions requested and displayed.

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

Returns
TypeDescription
List<Builder>

getDimensionsCount()

public int getDimensionsCount()

The dimensions requested and displayed.

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

Returns
TypeDescription
int

getDimensionsList()

public List<Dimension> getDimensionsList()

The dimensions requested and displayed.

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

Returns
TypeDescription
List<Dimension>

getDimensionsOrBuilder(int index)

public DimensionOrBuilder getDimensionsOrBuilder(int index)

The dimensions requested and displayed.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DimensionOrBuilder

getDimensionsOrBuilderList()

public List<? extends DimensionOrBuilder> getDimensionsOrBuilderList()

The dimensions requested and displayed.

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

Returns
TypeDescription
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.

bool keep_empty_rows = 13;

Returns
TypeDescription
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 100,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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
FilterExpressionOrBuilder

getMetrics(int index)

public Metric getMetrics(int index)

The metrics requested and displayed.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Metric

getMetricsBuilder(int index)

public Metric.Builder getMetricsBuilder(int index)

The metrics requested and displayed.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Metric.Builder

getMetricsBuilderList()

public List<Metric.Builder> getMetricsBuilderList()

The metrics requested and displayed.

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

Returns
TypeDescription
List<Builder>

getMetricsCount()

public int getMetricsCount()

The metrics requested and displayed.

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

Returns
TypeDescription
int

getMetricsList()

public List<Metric> getMetricsList()

The metrics requested and displayed.

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

Returns
TypeDescription
List<Metric>

getMetricsOrBuilder(int index)

public MetricOrBuilder getMetricsOrBuilder(int index)

The metrics requested and displayed.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
MetricOrBuilder

getMetricsOrBuilderList()

public List<? extends MetricOrBuilder> getMetricsOrBuilderList()

The metrics requested and displayed.

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

Returns
TypeDescription
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. 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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<Builder>

getOrderBysCount()

public int getOrderBysCount()

Specifies how rows are ordered in the response.

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

Returns
TypeDescription
int

getOrderBysList()

public List<OrderBy> getOrderBysList()

Specifies how rows are ordered in the response.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.analytics.data.v1beta.OrderByOrBuilder>

getProperty()

public String getProperty()

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234

string property = 1;

Returns
TypeDescription
String

The property.

getPropertyBytes()

public ByteString getPropertyBytes()

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234

string property = 1;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the cohortSpec field is set.

hasDimensionFilter()

public boolean hasDimensionFilter()

Dimension filters allow you to 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
TypeDescription
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
TypeDescription
boolean

Whether the metricFilter field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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
NameDescription
valueCohortSpec
Returns
TypeDescription
RunReportRequest.Builder

mergeDimensionFilter(FilterExpression value)

public RunReportRequest.Builder mergeDimensionFilter(FilterExpression value)

Dimension filters allow you to 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
NameDescription
valueFilterExpression
Returns
TypeDescription
RunReportRequest.Builder

mergeFrom(RunReportRequest other)

public RunReportRequest.Builder mergeFrom(RunReportRequest other)
Parameter
NameDescription
otherRunReportRequest
Returns
TypeDescription
RunReportRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunReportRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunReportRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RunReportRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RunReportRequest.Builder
Overrides

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
NameDescription
valueFilterExpression
Returns
TypeDescription
RunReportRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunReportRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RunReportRequest.Builder
Overrides

removeDateRanges(int index)

public RunReportRequest.Builder removeDateRanges(int index)

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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valueCohortSpec
Returns
TypeDescription
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
NameDescription
builderForValueCohortSpec.Builder
Returns
TypeDescription
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
NameDescription
valueString

The currencyCode to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for currencyCode to set.

Returns
TypeDescription
RunReportRequest.Builder

This builder for chaining.

setDateRanges(int index, DateRange value)

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

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;

Parameters
NameDescription
indexint
valueDateRange
Returns
TypeDescription
RunReportRequest.Builder

setDateRanges(int index, DateRange.Builder builderForValue)

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

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;

Parameters
NameDescription
indexint
builderForValueDateRange.Builder
Returns
TypeDescription
RunReportRequest.Builder

setDimensionFilter(FilterExpression value)

public RunReportRequest.Builder setDimensionFilter(FilterExpression value)

Dimension filters allow you to 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
NameDescription
valueFilterExpression
Returns
TypeDescription
RunReportRequest.Builder

setDimensionFilter(FilterExpression.Builder builderForValue)

public RunReportRequest.Builder setDimensionFilter(FilterExpression.Builder builderForValue)

Dimension filters allow you to 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
NameDescription
builderForValueFilterExpression.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueDimension
Returns
TypeDescription
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
NameDescription
indexint
builderForValueDimension.Builder
Returns
TypeDescription
RunReportRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RunReportRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RunReportRequest.Builder
Overrides

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.

bool keep_empty_rows = 13;

Parameter
NameDescription
valueboolean

The keepEmptyRows to set.

Returns
TypeDescription
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 100,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;

Parameter
NameDescription
valuelong

The limit to set.

Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueMetricAggregation

The metricAggregations to set.

Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueint

The enum numeric value on the wire for metricAggregations to set.

Returns
TypeDescription
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
NameDescription
valueFilterExpression
Returns
TypeDescription
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
NameDescription
builderForValueFilterExpression.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueMetric
Returns
TypeDescription
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
NameDescription
indexint
builderForValueMetric.Builder
Returns
TypeDescription
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. 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;

Parameter
NameDescription
valuelong

The offset to set.

Returns
TypeDescription
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
NameDescription
indexint
valueOrderBy
Returns
TypeDescription
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
NameDescription
indexint
builderForValueOrderBy.Builder
Returns
TypeDescription
RunReportRequest.Builder

setProperty(String value)

public RunReportRequest.Builder setProperty(String value)

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;

Parameter
NameDescription
valueString

The property to set.

Returns
TypeDescription
RunReportRequest.Builder

This builder for chaining.

setPropertyBytes(ByteString value)

public RunReportRequest.Builder setPropertyBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for property to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RunReportRequest.Builder
Overrides

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
NameDescription
valueboolean

The returnPropertyQuota to set.

Returns
TypeDescription
RunReportRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RunReportRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RunReportRequest.Builder
Overrides