Google Analytics Data V1alpha Client - Class RunReportResponse (0.17.1)

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

The response report table corresponding to a request.

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

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
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. To learn more about this pagination parameter, see Pagination.

↳ metadata Google\Analytics\Data\V1alpha\ResponseMetaData

Metadata for the report.

↳ property_quota Google\Analytics\Data\V1alpha\PropertyQuota

This Analytics Property's quota state including this request.

getDimensionHeaders

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDimensionHeaders

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

Parameter
Name Description
var array<Google\Analytics\Data\V1alpha\DimensionHeader>
Returns
Type Description
$this

getMetricHeaders

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMetricHeaders

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

Parameter
Name Description
var array<Google\Analytics\Data\V1alpha\MetricHeader>
Returns
Type Description
$this

getRows

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRows

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

Parameter
Name Description
var array<Google\Analytics\Data\V1alpha\Row>
Returns
Type Description
$this

getTotals

If requested, the totaled values of metrics.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTotals

If requested, the totaled values of metrics.

Parameter
Name Description
var array<Google\Analytics\Data\V1alpha\Row>
Returns
Type Description
$this

getMaximums

If requested, the maximum values of metrics.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMaximums

If requested, the maximum values of metrics.

Parameter
Name Description
var array<Google\Analytics\Data\V1alpha\Row>
Returns
Type Description
$this

getMinimums

If requested, the minimum values of metrics.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMinimums

If requested, the minimum values of metrics.

Parameter
Name Description
var array<Google\Analytics\Data\V1alpha\Row>
Returns
Type Description
$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.

To learn more about this pagination parameter, see Pagination.

Returns
Type Description
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.

To learn more about this pagination parameter, see Pagination.

Parameter
Name Description
var int
Returns
Type Description
$this

getMetadata

Metadata for the report.

Returns
Type Description
Google\Analytics\Data\V1alpha\ResponseMetaData|null

hasMetadata

clearMetadata

setMetadata

Metadata for the report.

Parameter
Name Description
var Google\Analytics\Data\V1alpha\ResponseMetaData
Returns
Type Description
$this

getPropertyQuota

This Analytics Property's quota state including this request.

Returns
Type Description
Google\Analytics\Data\V1alpha\PropertyQuota|null

hasPropertyQuota

clearPropertyQuota

setPropertyQuota

This Analytics Property's quota state including this request.

Parameter
Name Description
var Google\Analytics\Data\V1alpha\PropertyQuota
Returns
Type Description
$this