Google Analytics Data V1beta Client - Class RunRealtimeReportRequest (0.9.5)

Version 0.9.5

• 0.20.1 (latest)
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.1
• 0.16.4
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.2
• 0.10.1
• 0.9.5

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Analytics Data V1beta Client class RunRealtimeReportRequest.

The request to generate a realtime report.

Generated from protobuf message google.analytics.data.v1beta.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\V1beta\Dimension> The dimensions requested and displayed.
↳ metrics	array<Google\Analytics\Data\V1beta\Metric> The metrics requested and displayed.
↳ dimension_filter	Google\Analytics\Data\V1beta\FilterExpression The filter clause of dimensions. Metrics cannot be used in this filter.
↳ metric_filter	Google\Analytics\Data\V1beta\FilterExpression The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.
↳ limit	int|string 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.
↳ metric_aggregations	array 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\V1beta\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.
↳ minute_ranges	array<Google\Analytics\Data\V1beta\MinuteRange> 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.

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\V1beta\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\V1beta\Metric>

Returns
Type	Description
$this

getDimensionFilter

The filter clause of dimensions. Metrics cannot be used in this filter.

Returns
Type	Description
Google\Analytics\Data\V1beta\FilterExpression|null

hasDimensionFilter

clearDimensionFilter

setDimensionFilter

The filter clause of dimensions. Metrics cannot be used in this filter.

Parameter
Name	Description
var	Google\Analytics\Data\V1beta\FilterExpression

Returns
Type	Description
$this

getMetricFilter

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.

Returns
Type	Description
Google\Analytics\Data\V1beta\FilterExpression|null

hasMetricFilter

clearMetricFilter

setMetricFilter

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.

Parameter
Name	Description
var	Google\Analytics\Data\V1beta\FilterExpression

Returns
Type	Description
$this

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.

Returns
Type	Description
int|string

setLimit

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.

Parameter
Name	Description
var	int|string

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\V1beta\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

getMinuteRanges

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.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setMinuteRanges

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.

Parameter
Name	Description
var	array<Google\Analytics\Data\V1beta\MinuteRange>

Returns
Type	Description
$this