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
Namespace
Google \ Analytics \ Data \ V1alphaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ pivot_headers |
array<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 |
↳ dimension_headers |
array<DimensionHeader>
Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows. |
↳ metric_headers |
array<MetricHeader>
Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. |
↳ rows |
array<Row>
Rows of dimension value combinations and metric values in the report. |
↳ aggregates |
array<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 |
ResponseMetaData
Metadata for the report. |
↳ property_quota |
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
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" }]
}]
}]
| Parameter | |
|---|---|
| Name | Description |
var |
array<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<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<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<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
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_
| Parameter | |
|---|---|
| Name | Description |
var |
array<Row>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMetadata
Metadata for the report.
| Returns | |
|---|---|
| Type | Description |
ResponseMetaData|null |
|
hasMetadata
clearMetadata
setMetadata
Metadata for the report.
| Parameter | |
|---|---|
| Name | Description |
var |
ResponseMetaData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPropertyQuota
This Analytics Property's quota state including this request.
| Returns | |
|---|---|
| Type | Description |
PropertyQuota|null |
|
hasPropertyQuota
clearPropertyQuota
setPropertyQuota
This Analytics Property's quota state including this request.
| Parameter | |
|---|---|
| Name | Description |
var |
PropertyQuota
|
| Returns | |
|---|---|
| Type | Description |
$this |
|