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.
| Parameters | |
|---|---|
| Name | Description |
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 |
array<Google\Analytics\Data\V1alpha\Dimension>
The dimensions requested and displayed. |
↳ metrics |
array<Google\Analytics\Data\V1alpha\Metric>
The metrics requested and displayed. |
↳ 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 |
array<Google\Analytics\Data\V1alpha\OrderBy>
Specifies how rows are ordered in the response. |
↳ 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
| Returns | |
|---|---|
| Type | Description |
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
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDimensions
The dimensions requested and displayed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setDimensions
The dimensions requested and displayed.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Analytics\Data\V1alpha\Dimension>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMetrics
The metrics requested and displayed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setMetrics
The metrics requested and displayed.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Analytics\Data\V1alpha\Metric>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLimit
The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setLimit
The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDimensionFilter
The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
| Returns | |
|---|---|
| Type | Description |
Google\Analytics\Data\V1alpha\FilterExpression|null | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Analytics\Data\V1alpha\FilterExpression
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Analytics\Data\V1alpha\FilterExpression|null | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Analytics\Data\V1alpha\FilterExpression
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMetricAggregations
Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setMetricAggregations
Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrderBys
Specifies how rows are ordered in the response.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setOrderBys
Specifies how rows are ordered in the response.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Analytics\Data\V1alpha\OrderBy>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReturnPropertyQuota
Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in PropertyQuota.
| Returns | |
|---|---|
| Type | Description |
bool | |
setReturnPropertyQuota
Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in PropertyQuota.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |