- 0.63.0 (latest)
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
public interface RunRealtimeReportRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDimensionFilter()
public abstract 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. |
getDimensionFilterOrBuilder()
public abstract 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 abstract 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 |
|
getDimensionsCount()
public abstract int getDimensionsCount()The dimensions requested and displayed.
repeated .google.analytics.data.v1beta.Dimension dimensions = 2;
| Returns | |
|---|---|
| Type | Description |
int |
|
getDimensionsList()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
MetricAggregation |
The metricAggregations at the given index. |
getMetricAggregationsCount()
public abstract 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 abstract 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 abstract 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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of metricAggregations at the given index. |
getMetricAggregationsValueList()
public abstract List<Integer> getMetricAggregationsValueList()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 abstract 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. |
getMetricFilterOrBuilder()
public abstract 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 abstract 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 |
|
getMetricsCount()
public abstract int getMetricsCount()The metrics requested and displayed.
repeated .google.analytics.data.v1beta.Metric metrics = 3;
| Returns | |
|---|---|
| Type | Description |
int |
|
getMetricsList()
public abstract 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 abstract 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 abstract 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 abstract 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 |
|
getMinuteRangesCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 |
|
getOrderBysCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |