Google Analytics Data V1alpha Client - Class RunRealtimeReportRequest (0.11.2)

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

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getDimensions

The dimensions requested and displayed.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDimensions

The dimensions requested and displayed.

Parameter
NameDescription
var array<Google\Analytics\Data\V1alpha\Dimension>
Returns
TypeDescription
$this

getMetrics

The metrics requested and displayed.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMetrics

The metrics requested and displayed.

Parameter
NameDescription
var array<Google\Analytics\Data\V1alpha\Metric>
Returns
TypeDescription
$this

getLimit

The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.

Returns
TypeDescription
int|string

setLimit

The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Analytics\Data\V1alpha\FilterExpression
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Analytics\Data\V1alpha\FilterExpression
Returns
TypeDescription
$this

getMetricAggregations

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

Returns
TypeDescription
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
NameDescription
var int[]
Returns
TypeDescription
$this

getOrderBys

Specifies how rows are ordered in the response.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setOrderBys

Specifies how rows are ordered in the response.

Parameter
NameDescription
var array<Google\Analytics\Data\V1alpha\OrderBy>
Returns
TypeDescription
$this

getReturnPropertyQuota

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

Returns
TypeDescription
bool

setReturnPropertyQuota

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this