Reference documentation and code samples for the Google Analytics Data V1beta Client class Pivot.
Describes the visible dimension columns and rows in the report response.
Generated from protobuf message google.analytics.data.v1beta.Pivot
Namespace
Google \ Analytics \ Data \ V1betaMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ field_names
array
Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.
↳ order_bys
array< Google\Analytics\Data\V1beta\OrderBy
>
Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.
↳ offset
int|string
The row count of the start row. The first row is counted as row 0.
↳ limit
int|string
The number of unique combinations of dimension values to return in this pivot. The limit
parameter is required. A limit
of 10,000 is common for single pivot requests. The product of the limit
for each pivot
in a RunPivotReportRequest
must not exceed 100,000. For example, a two pivot request with limit: 1000
in each pivot will fail because the product is 1,000,000
.
↳ metric_aggregations
array
Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
getFieldNames
Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.
setFieldNames
Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.
var
string[]
$this
getOrderBys
Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering.
Dimensions specified in these OrderBys must be a subset of Pivot.field_names.
setOrderBys
Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering.
Dimensions specified in these OrderBys must be a subset of Pivot.field_names.
$this
getOffset
The row count of the start row. The first row is counted as row 0.
int|string
setOffset
The row count of the start row. The first row is counted as row 0.
var
int|string
$this
getLimit
The number of unique combinations of dimension values to return in this
pivot. The limit
parameter is required. A limit
of 10,000 is common for
single pivot requests.
The product of the limit
for each pivot
in a RunPivotReportRequest
must not exceed 100,000. For example, a two pivot request with limit:
1000
in each pivot will fail because the product is 1,000,000
.
int|string
setLimit
The number of unique combinations of dimension values to return in this
pivot. The limit
parameter is required. A limit
of 10,000 is common for
single pivot requests.
The product of the limit
for each pivot
in a RunPivotReportRequest
must not exceed 100,000. For example, a two pivot request with limit:
1000
in each pivot will fail because the product is 1,000,000
.
var
int|string
$this
getMetricAggregations
Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
setMetricAggregations
Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
var
int[]
$this
