Google Analytics Data V1alpha Client - Class Pivot (0.10.1)

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

Describes the visible dimension columns and rows in the report response.

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

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ field_names`	`string[]` 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\V1alpha\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 rows to return in this pivot. If unspecified, 10 rows are returned. If -1, all rows are returned.
`↳ metric_aggregations`	`int[]` 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

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

Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

Parameter
Name	Description
`var`	`array<Google\Analytics\Data\V1alpha\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 rows to return in this pivot. If unspecified, 10 rows are returned. If -1, all rows are returned.

Returns
Type	Description
`int\|string`

setLimit

The number of rows to return in this pivot. If unspecified, 10 rows are returned. If -1, all rows are returned.

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`