public final class RunRealtimeReportRequest extends GeneratedMessageV3 implements RunRealtimeReportRequestOrBuilder
The request to generate a realtime report.
Protobuf type google.analytics.data.v1beta.RunRealtimeReportRequest
Static Fields
DIMENSIONS_FIELD_NUMBER
public static final int DIMENSIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DIMENSION_FILTER_FIELD_NUMBER
public static final int DIMENSION_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LIMIT_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
METRICS_FIELD_NUMBER
public static final int METRICS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
METRIC_AGGREGATIONS_FIELD_NUMBER
public static final int METRIC_AGGREGATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
METRIC_FILTER_FIELD_NUMBER
public static final int METRIC_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MINUTE_RANGES_FIELD_NUMBER
public static final int MINUTE_RANGES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ORDER_BYS_FIELD_NUMBER
public static final int ORDER_BYS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROPERTY_FIELD_NUMBER
public static final int PROPERTY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RETURN_PROPERTY_QUOTA_FIELD_NUMBER
public static final int RETURN_PROPERTY_QUOTA_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static RunRealtimeReportRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RunRealtimeReportRequest.Builder newBuilder()
newBuilder(RunRealtimeReportRequest prototype)
public static RunRealtimeReportRequest.Builder newBuilder(RunRealtimeReportRequest prototype)
public static RunRealtimeReportRequest parseDelimitedFrom(InputStream input)
public static RunRealtimeReportRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RunRealtimeReportRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RunRealtimeReportRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RunRealtimeReportRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunRealtimeReportRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunRealtimeReportRequest parseFrom(CodedInputStream input)
public static RunRealtimeReportRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RunRealtimeReportRequest parseFrom(InputStream input)
public static RunRealtimeReportRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RunRealtimeReportRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RunRealtimeReportRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RunRealtimeReportRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public RunRealtimeReportRequest getDefaultInstanceForType()
getDimensionFilter()
public FilterExpression getDimensionFilter()
The filter clause of dimensions. Metrics cannot be used in this filter.
.google.analytics.data.v1beta.FilterExpression dimension_filter = 4;
getDimensionFilterOrBuilder()
public FilterExpressionOrBuilder getDimensionFilterOrBuilder()
The filter clause of dimensions. Metrics cannot be used in this filter.
.google.analytics.data.v1beta.FilterExpression dimension_filter = 4;
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
|
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;
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
|
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()
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.
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.
|
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;
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;
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;
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
|
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;
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
|
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
|
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;
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
|
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
|
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;
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
|
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> | |
getParserForType()
public Parser<RunRealtimeReportRequest> getParserForType()
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RunRealtimeReportRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RunRealtimeReportRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public RunRealtimeReportRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
