Class RunRealtimeReportRequest.Builder (0.55.0)

public static final class RunRealtimeReportRequest.Builder extends GeneratedMessageV3.Builder<RunRealtimeReportRequest.Builder> implements RunRealtimeReportRequestOrBuilder

The request to generate a realtime report.

Protobuf type google.analytics.data.v1beta.RunRealtimeReportRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllDimensions(Iterable<? extends Dimension> values)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.Builder

addAllMetricAggregations(Iterable<? extends MetricAggregation> values)

public RunRealtimeReportRequest.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 = 7;

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

The metricAggregations to add.

Returns
Type Description
RunRealtimeReportRequest.Builder

This builder for chaining.

addAllMetricAggregationsValue(Iterable<Integer> values)

public RunRealtimeReportRequest.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 = 7;

Parameter
Name Description
values Iterable<Integer>

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

Returns
Type Description
RunRealtimeReportRequest.Builder

This builder for chaining.

addAllMetrics(Iterable<? extends Metric> values)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.Builder

addAllMinuteRanges(Iterable<? extends MinuteRange> values)

public RunRealtimeReportRequest.Builder addAllMinuteRanges(Iterable<? extends MinuteRange> values)

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Parameter
Name Description
values Iterable<? extends com.google.analytics.data.v1beta.MinuteRange>
Returns
Type Description
RunRealtimeReportRequest.Builder

addAllOrderBys(Iterable<? extends OrderBy> values)

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

Specifies how rows are ordered in the response.

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

Parameter
Name Description
values Iterable<? extends com.google.analytics.data.v1beta.OrderBy>
Returns
Type Description
RunRealtimeReportRequest.Builder

addDimensions(Dimension value)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.Builder

addDimensions(Dimension.Builder builderForValue)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.Builder

addDimensions(int index, Dimension value)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.Builder

addDimensions(int index, Dimension.Builder builderForValue)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.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 RunRealtimeReportRequest.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 = 7;

Parameter
Name Description
value MetricAggregation

The metricAggregations to add.

Returns
Type Description
RunRealtimeReportRequest.Builder

This builder for chaining.

addMetricAggregationsValue(int value)

public RunRealtimeReportRequest.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 = 7;

Parameter
Name Description
value int

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

Returns
Type Description
RunRealtimeReportRequest.Builder

This builder for chaining.

addMetrics(Metric value)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.Builder

addMetrics(Metric.Builder builderForValue)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.Builder

addMetrics(int index, Metric value)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.Builder

addMetrics(int index, Metric.Builder builderForValue)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.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

addMinuteRanges(MinuteRange value)

public RunRealtimeReportRequest.Builder addMinuteRanges(MinuteRange value)

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Parameter
Name Description
value MinuteRange
Returns
Type Description
RunRealtimeReportRequest.Builder

addMinuteRanges(MinuteRange.Builder builderForValue)

public RunRealtimeReportRequest.Builder addMinuteRanges(MinuteRange.Builder builderForValue)

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Parameter
Name Description
builderForValue MinuteRange.Builder
Returns
Type Description
RunRealtimeReportRequest.Builder

addMinuteRanges(int index, MinuteRange value)

public RunRealtimeReportRequest.Builder addMinuteRanges(int index, MinuteRange value)

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Parameters
Name Description
index int
value MinuteRange
Returns
Type Description
RunRealtimeReportRequest.Builder

addMinuteRanges(int index, MinuteRange.Builder builderForValue)

public RunRealtimeReportRequest.Builder addMinuteRanges(int index, MinuteRange.Builder builderForValue)

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Parameters
Name Description
index int
builderForValue MinuteRange.Builder
Returns
Type Description
RunRealtimeReportRequest.Builder

addMinuteRangesBuilder()

public MinuteRange.Builder addMinuteRangesBuilder()

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Returns
Type Description
MinuteRange.Builder

addMinuteRangesBuilder(int index)

public MinuteRange.Builder addMinuteRangesBuilder(int index)

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Parameter
Name Description
index int
Returns
Type Description
MinuteRange.Builder

addOrderBys(OrderBy value)

public RunRealtimeReportRequest.Builder addOrderBys(OrderBy value)

Specifies how rows are ordered in the response.

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

Parameter
Name Description
value OrderBy
Returns
Type Description
RunRealtimeReportRequest.Builder

addOrderBys(OrderBy.Builder builderForValue)

public RunRealtimeReportRequest.Builder addOrderBys(OrderBy.Builder builderForValue)

Specifies how rows are ordered in the response.

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

Parameter
Name Description
builderForValue OrderBy.Builder
Returns
Type Description
RunRealtimeReportRequest.Builder

addOrderBys(int index, OrderBy value)

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

Specifies how rows are ordered in the response.

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

Parameters
Name Description
index int
value OrderBy
Returns
Type Description
RunRealtimeReportRequest.Builder

addOrderBys(int index, OrderBy.Builder builderForValue)

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

Specifies how rows are ordered in the response.

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

Parameters
Name Description
index int
builderForValue OrderBy.Builder
Returns
Type Description
RunRealtimeReportRequest.Builder

addOrderBysBuilder()

public OrderBy.Builder addOrderBysBuilder()

Specifies how rows are ordered in the response.

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

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

Parameter
Name Description
index int
Returns
Type Description
OrderBy.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunRealtimeReportRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunRealtimeReportRequest.Builder
Overrides

build()

public RunRealtimeReportRequest build()
Returns
Type Description
RunRealtimeReportRequest

buildPartial()

public RunRealtimeReportRequest buildPartial()
Returns
Type Description
RunRealtimeReportRequest

clear()

public RunRealtimeReportRequest.Builder clear()
Returns
Type Description
RunRealtimeReportRequest.Builder
Overrides

clearDimensionFilter()

public RunRealtimeReportRequest.Builder clearDimensionFilter()

The filter clause of dimensions. Metrics cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression dimension_filter = 4;

Returns
Type Description
RunRealtimeReportRequest.Builder

clearDimensions()

public RunRealtimeReportRequest.Builder clearDimensions()

The dimensions requested and displayed.

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

Returns
Type Description
RunRealtimeReportRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public RunRealtimeReportRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RunRealtimeReportRequest.Builder
Overrides

clearLimit()

public RunRealtimeReportRequest.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.

int64 limit = 6;

Returns
Type Description
RunRealtimeReportRequest.Builder

This builder for chaining.

clearMetricAggregations()

public RunRealtimeReportRequest.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 = 7;

Returns
Type Description
RunRealtimeReportRequest.Builder

This builder for chaining.

clearMetricFilter()

public RunRealtimeReportRequest.Builder clearMetricFilter()

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression metric_filter = 5;

Returns
Type Description
RunRealtimeReportRequest.Builder

clearMetrics()

public RunRealtimeReportRequest.Builder clearMetrics()

The metrics requested and displayed.

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

Returns
Type Description
RunRealtimeReportRequest.Builder

clearMinuteRanges()

public RunRealtimeReportRequest.Builder clearMinuteRanges()

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Returns
Type Description
RunRealtimeReportRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public RunRealtimeReportRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RunRealtimeReportRequest.Builder
Overrides

clearOrderBys()

public RunRealtimeReportRequest.Builder clearOrderBys()

Specifies how rows are ordered in the response.

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

Returns
Type Description
RunRealtimeReportRequest.Builder

clearProperty()

public RunRealtimeReportRequest.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.

Example: properties/1234

string property = 1;

Returns
Type Description
RunRealtimeReportRequest.Builder

This builder for chaining.

clearReturnPropertyQuota()

public RunRealtimeReportRequest.Builder clearReturnPropertyQuota()

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

bool return_property_quota = 9;

Returns
Type Description
RunRealtimeReportRequest.Builder

This builder for chaining.

clone()

public RunRealtimeReportRequest.Builder clone()
Returns
Type Description
RunRealtimeReportRequest.Builder
Overrides

getDefaultInstanceForType()

public RunRealtimeReportRequest getDefaultInstanceForType()
Returns
Type Description
RunRealtimeReportRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDimensionFilter()

public FilterExpression getDimensionFilter()

The filter clause of dimensions. Metrics cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression dimension_filter = 4;

Returns
Type Description
FilterExpression

The dimensionFilter.

getDimensionFilterBuilder()

public FilterExpression.Builder getDimensionFilterBuilder()

The filter clause of dimensions. Metrics cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression dimension_filter = 4;

Returns
Type Description
FilterExpression.Builder

getDimensionFilterOrBuilder()

public FilterExpressionOrBuilder getDimensionFilterOrBuilder()

The filter clause of dimensions. Metrics cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression dimension_filter = 4;

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>

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.

The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value.

int64 limit = 6;

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

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

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

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

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

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 at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression metric_filter = 5;

Returns
Type Description
FilterExpression

The metricFilter.

getMetricFilterBuilder()

public FilterExpression.Builder getMetricFilterBuilder()

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression metric_filter = 5;

Returns
Type Description
FilterExpression.Builder

getMetricFilterOrBuilder()

public FilterExpressionOrBuilder getMetricFilterOrBuilder()

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression metric_filter = 5;

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>

getMinuteRanges(int index)

public MinuteRange getMinuteRanges(int index)

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Parameter
Name Description
index int
Returns
Type Description
MinuteRange

getMinuteRangesBuilder(int index)

public MinuteRange.Builder getMinuteRangesBuilder(int index)

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Parameter
Name Description
index int
Returns
Type Description
MinuteRange.Builder

getMinuteRangesBuilderList()

public List<MinuteRange.Builder> getMinuteRangesBuilderList()

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Returns
Type Description
List<Builder>

getMinuteRangesCount()

public int getMinuteRangesCount()

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Returns
Type Description
int

getMinuteRangesList()

public List<MinuteRange> getMinuteRangesList()

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Returns
Type Description
List<MinuteRange>

getMinuteRangesOrBuilder(int index)

public MinuteRangeOrBuilder getMinuteRangesOrBuilder(int index)

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Parameter
Name Description
index int
Returns
Type Description
MinuteRangeOrBuilder

getMinuteRangesOrBuilderList()

public List<? extends MinuteRangeOrBuilder> getMinuteRangesOrBuilderList()

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

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

getOrderBys(int index)

public OrderBy getOrderBys(int index)

Specifies how rows are ordered in the response.

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

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

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

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

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

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

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

Returns
Type Description
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.

Example: properties/1234

string property = 1;

Returns
Type Description
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.

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 Realtime quota. Quota is returned in PropertyQuota.

bool return_property_quota = 9;

Returns
Type Description
boolean

The returnPropertyQuota.

hasDimensionFilter()

public boolean hasDimensionFilter()

The filter clause of dimensions. Metrics cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression dimension_filter = 4;

Returns
Type Description
boolean

Whether the dimensionFilter field is set.

hasMetricFilter()

public boolean hasMetricFilter()

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression metric_filter = 5;

Returns
Type Description
boolean

Whether the metricFilter field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDimensionFilter(FilterExpression value)

public RunRealtimeReportRequest.Builder mergeDimensionFilter(FilterExpression value)

The filter clause of dimensions. Metrics cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression dimension_filter = 4;

Parameter
Name Description
value FilterExpression
Returns
Type Description
RunRealtimeReportRequest.Builder

mergeFrom(RunRealtimeReportRequest other)

public RunRealtimeReportRequest.Builder mergeFrom(RunRealtimeReportRequest other)
Parameter
Name Description
other RunRealtimeReportRequest
Returns
Type Description
RunRealtimeReportRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunRealtimeReportRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunRealtimeReportRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RunRealtimeReportRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RunRealtimeReportRequest.Builder
Overrides

mergeMetricFilter(FilterExpression value)

public RunRealtimeReportRequest.Builder mergeMetricFilter(FilterExpression value)

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression metric_filter = 5;

Parameter
Name Description
value FilterExpression
Returns
Type Description
RunRealtimeReportRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunRealtimeReportRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunRealtimeReportRequest.Builder
Overrides

removeDimensions(int index)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.Builder

removeMetrics(int index)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.Builder

removeMinuteRanges(int index)

public RunRealtimeReportRequest.Builder removeMinuteRanges(int index)

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Parameter
Name Description
index int
Returns
Type Description
RunRealtimeReportRequest.Builder

removeOrderBys(int index)

public RunRealtimeReportRequest.Builder removeOrderBys(int index)

Specifies how rows are ordered in the response.

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

Parameter
Name Description
index int
Returns
Type Description
RunRealtimeReportRequest.Builder

setDimensionFilter(FilterExpression value)

public RunRealtimeReportRequest.Builder setDimensionFilter(FilterExpression value)

The filter clause of dimensions. Metrics cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression dimension_filter = 4;

Parameter
Name Description
value FilterExpression
Returns
Type Description
RunRealtimeReportRequest.Builder

setDimensionFilter(FilterExpression.Builder builderForValue)

public RunRealtimeReportRequest.Builder setDimensionFilter(FilterExpression.Builder builderForValue)

The filter clause of dimensions. Metrics cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression dimension_filter = 4;

Parameter
Name Description
builderForValue FilterExpression.Builder
Returns
Type Description
RunRealtimeReportRequest.Builder

setDimensions(int index, Dimension value)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.Builder

setDimensions(int index, Dimension.Builder builderForValue)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RunRealtimeReportRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunRealtimeReportRequest.Builder
Overrides

setLimit(long value)

public RunRealtimeReportRequest.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.

The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value.

int64 limit = 6;

Parameter
Name Description
value long

The limit to set.

Returns
Type Description
RunRealtimeReportRequest.Builder

This builder for chaining.

setMetricAggregations(int index, MetricAggregation value)

public RunRealtimeReportRequest.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 = 7;

Parameters
Name Description
index int

The index to set the value at.

value MetricAggregation

The metricAggregations to set.

Returns
Type Description
RunRealtimeReportRequest.Builder

This builder for chaining.

setMetricAggregationsValue(int index, int value)

public RunRealtimeReportRequest.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 = 7;

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
RunRealtimeReportRequest.Builder

This builder for chaining.

setMetricFilter(FilterExpression value)

public RunRealtimeReportRequest.Builder setMetricFilter(FilterExpression value)

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression metric_filter = 5;

Parameter
Name Description
value FilterExpression
Returns
Type Description
RunRealtimeReportRequest.Builder

setMetricFilter(FilterExpression.Builder builderForValue)

public RunRealtimeReportRequest.Builder setMetricFilter(FilterExpression.Builder builderForValue)

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression metric_filter = 5;

Parameter
Name Description
builderForValue FilterExpression.Builder
Returns
Type Description
RunRealtimeReportRequest.Builder

setMetrics(int index, Metric value)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.Builder

setMetrics(int index, Metric.Builder builderForValue)

public RunRealtimeReportRequest.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
RunRealtimeReportRequest.Builder

setMinuteRanges(int index, MinuteRange value)

public RunRealtimeReportRequest.Builder setMinuteRanges(int index, MinuteRange value)

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Parameters
Name Description
index int
value MinuteRange
Returns
Type Description
RunRealtimeReportRequest.Builder

setMinuteRanges(int index, MinuteRange.Builder builderForValue)

public RunRealtimeReportRequest.Builder setMinuteRanges(int index, MinuteRange.Builder builderForValue)

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

Parameters
Name Description
index int
builderForValue MinuteRange.Builder
Returns
Type Description
RunRealtimeReportRequest.Builder

setOrderBys(int index, OrderBy value)

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

Specifies how rows are ordered in the response.

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

Parameters
Name Description
index int
value OrderBy
Returns
Type Description
RunRealtimeReportRequest.Builder

setOrderBys(int index, OrderBy.Builder builderForValue)

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

Specifies how rows are ordered in the response.

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

Parameters
Name Description
index int
builderForValue OrderBy.Builder
Returns
Type Description
RunRealtimeReportRequest.Builder

setProperty(String value)

public RunRealtimeReportRequest.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.

Example: properties/1234

string property = 1;

Parameter
Name Description
value String

The property to set.

Returns
Type Description
RunRealtimeReportRequest.Builder

This builder for chaining.

setPropertyBytes(ByteString value)

public RunRealtimeReportRequest.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.

Example: properties/1234

string property = 1;

Parameter
Name Description
value ByteString

The bytes for property to set.

Returns
Type Description
RunRealtimeReportRequest.Builder

This builder for chaining.

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

public RunRealtimeReportRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RunRealtimeReportRequest.Builder
Overrides

setReturnPropertyQuota(boolean value)

public RunRealtimeReportRequest.Builder setReturnPropertyQuota(boolean value)

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

bool return_property_quota = 9;

Parameter
Name Description
value boolean

The returnPropertyQuota to set.

Returns
Type Description
RunRealtimeReportRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RunRealtimeReportRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunRealtimeReportRequest.Builder
Overrides