Reference documentation and code samples for the Google Analytics Data V1alpha Client class RunRealtimeReportRequest.
The request to generate a realtime report.
Generated from protobuf message google.analytics.data.v1alpha.RunRealtimeReportRequest
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ property
string
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
↳ dimensions
↳ metrics
↳ limit
int|string
The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.
↳ dimension_filter
Google\Analytics\Data\V1alpha\FilterExpression
The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
↳ metric_filter
Google\Analytics\Data\V1alpha\FilterExpression
The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.
↳ metric_aggregations
int[]
Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
↳ order_bys
↳ return_property_quota
bool
Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in PropertyQuota .
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
setProperty
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
var
string
$this
getDimensions
The dimensions requested and displayed.
setDimensions
The dimensions requested and displayed.
$this
getMetrics
The metrics requested and displayed.
setMetrics
The metrics requested and displayed.
$this
getLimit
The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.
int|string
setLimit
The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.
var
int|string
$this
getDimensionFilter
The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
hasDimensionFilter
clearDimensionFilter
setDimensionFilter
The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
$this
getMetricFilter
The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter.
Dimensions cannot be used in this filter.
hasMetricFilter
clearMetricFilter
setMetricFilter
The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter.
Dimensions cannot be used in this filter.
$this
getMetricAggregations
Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
setMetricAggregations
Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
var
int[]
$this
getOrderBys
Specifies how rows are ordered in the response.
setOrderBys
Specifies how rows are ordered in the response.
$this
getReturnPropertyQuota
Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in PropertyQuota .
bool
setReturnPropertyQuota
Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in PropertyQuota .
var
bool
$this
