Google Analytics Data V1alpha Client - Class RunRealtimeReportResponse (0.9.5)

Reference documentation and code samples for the Google Analytics Data V1alpha Client class RunRealtimeReportResponse.

The response realtime report table corresponding to a request.

Generated from protobuf message google.analytics.data.v1alpha.RunRealtimeReportResponse

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ dimension_headers array<Google\Analytics\Data\V1alpha\DimensionHeader>

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

↳ metric_headers array<Google\Analytics\Data\V1alpha\MetricHeader>

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

↳ rows array<Google\Analytics\Data\V1alpha\Row>

Rows of dimension value combinations and metric values in the report.

↳ totals array<Google\Analytics\Data\V1alpha\Row>

If requested, the totaled values of metrics.

↳ maximums array<Google\Analytics\Data\V1alpha\Row>

If requested, the maximum values of metrics.

↳ minimums array<Google\Analytics\Data\V1alpha\Row>

If requested, the minimum values of metrics.

↳ row_count int

The total number of rows in the query result, regardless of the number of rows returned in the response. For example if a query returns 175 rows and includes limit = 50 in the API request, the response will contain row_count = 175 but only 50 rows.

↳ property_quota Google\Analytics\Data\V1alpha\PropertyQuota

This Analytics Property's Realtime quota state including this request.

getDimensionHeaders

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDimensionHeaders

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

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

getMetricHeaders

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMetricHeaders

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

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

getRows

Rows of dimension value combinations and metric values in the report.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRows

Rows of dimension value combinations and metric values in the report.

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

getTotals

If requested, the totaled values of metrics.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTotals

If requested, the totaled values of metrics.

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

getMaximums

If requested, the maximum values of metrics.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMaximums

If requested, the maximum values of metrics.

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

getMinimums

If requested, the minimum values of metrics.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMinimums

If requested, the minimum values of metrics.

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

getRowCount

The total number of rows in the query result, regardless of the number of rows returned in the response. For example if a query returns 175 rows and includes limit = 50 in the API request, the response will contain row_count = 175 but only 50 rows.

Returns
TypeDescription
int

setRowCount

The total number of rows in the query result, regardless of the number of rows returned in the response. For example if a query returns 175 rows and includes limit = 50 in the API request, the response will contain row_count = 175 but only 50 rows.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPropertyQuota

This Analytics Property's Realtime quota state including this request.

Returns
TypeDescription
Google\Analytics\Data\V1alpha\PropertyQuota|null

hasPropertyQuota

clearPropertyQuota

setPropertyQuota

This Analytics Property's Realtime quota state including this request.

Parameter
NameDescription
var Google\Analytics\Data\V1alpha\PropertyQuota
Returns
TypeDescription
$this