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.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Analytics\Data\V1beta\OrderBy>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOffset
The row count of the start row. The first row is counted as row 0.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setOffset
The row count of the start row. The first row is counted as row 0.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMetricAggregations
Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setMetricAggregations
Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |