Reference documentation and code samples for the Google Analytics Data V1beta Client class RunPivotReportResponse.
The response pivot report table corresponding to a pivot request.
Generated from protobuf message google.analytics.data.v1beta.RunPivotReportResponse
Namespace
Google \ Analytics \ Data \ V1betaMethods
__construct
Constructor.
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 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< 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
↳ 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
↳ property_quota
↳ kind
string
Identifies what kind of resource this message is. This kind
is always the fixed string "analyticsData#runPivotReport". Useful to distinguish between response types in JSON.
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" }]
}]
}]
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" }]
}]
}]
$this
getDimensionHeaders
Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.
setDimensionHeaders
Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.
$this
getMetricHeaders
Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.
setMetricHeaders
Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.
$this
getRows
Rows of dimension value combinations and metric values in the report.
setRows
Rows of dimension value combinations and metric values in the report.
$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_
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_
$this
getMetadata
Metadata for the report.
hasMetadata
clearMetadata
setMetadata
Metadata for the report.
$this
getPropertyQuota
This Google Analytics property's quota state including this request.
hasPropertyQuota
clearPropertyQuota
setPropertyQuota
This Google Analytics property's quota state including this request.
$this
getKind
Identifies what kind of resource this message is. This kind
is always the
fixed string "analyticsData#runPivotReport". Useful to distinguish between
response types in JSON.
string
setKind
Identifies what kind of resource this message is. This kind
is always the
fixed string "analyticsData#runPivotReport". Useful to distinguish between
response types in JSON.
var
string
$this
