Google Analytics Data V1alpha Client - Class RunPivotReportResponse (0.9.5)

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

The response pivot report table corresponding to a pivot request.

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

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ pivot_headers`	`array<Google\Analytics\Data\V1alpha\PivotHeader>` Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this: "pivots": [{ "fieldNames": ["country", "city"] }, { "fieldNames": "eventName" }] We will have the following `pivotHeaders` in the response: "pivotHeaders" : [{ "dimensionHeaders": [{ "dimensionValues": [ { "value": "United Kingdom" }, { "value": "London" } ] }, { "dimensionValues": [ { "value": "Japan" }, { "value": "Osaka" } ] }] }, { "dimensionHeaders": [{ "dimensionValues": [{ "value": "session_start" }] }, { "dimensionValues": [{ "value": "scroll" }] }] }]
`↳ 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.
`↳ aggregates`	`array<Google\Analytics\Data\V1alpha\Row>` Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_
`↳ 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.

getPivotHeaders

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this: "pivots": [{ "fieldNames": ["country", "city"] }, { "fieldNames": "eventName" }] We will have the following pivotHeaders in the response: "pivotHeaders" : [{ "dimensionHeaders": [{ "dimensionValues": [ { "value": "United Kingdom" }, { "value": "London" } ] }, { "dimensionValues": [ { "value": "Japan" }, { "value": "Osaka" } ] }] }, { "dimensionHeaders": [{ "dimensionValues": [{ "value": "session_start" }] }, { "dimensionValues": [{ "value": "scroll" }] }] }]

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setPivotHeaders

Parameter
Name	Description
`var`	`array<Google\Analytics\Data\V1alpha\PivotHeader>`

Returns
Type	Description
`$this`

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`

getAggregates

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setAggregates

Parameter
Name	Description
`var`	`array<Google\Analytics\Data\V1alpha\Row>`

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`