Reference documentation and code samples for the Google Analytics Data V1alpha Client class PivotOrderBy.
Sorts by a pivot column group.
Generated from protobuf message google.analytics.data.v1alpha.OrderBy.PivotOrderBy
Namespace
Google \ Analytics \ Data \ V1alpha \ OrderByMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ metric_name |
string
In the response to order by, order rows by this column. Must be a metric name from the request. |
↳ pivot_selections |
array<PivotOrderBy\PivotSelection>
Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair. |
getMetricName
In the response to order by, order rows by this column. Must be a metric name from the request.
| Returns | |
|---|---|
| Type | Description |
string |
|
setMetricName
In the response to order by, order rows by this column. Must be a metric name from the request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPivotSelections
Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPivotSelections
Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.
| Parameter | |
|---|---|
| Name | Description |
var |
array<PivotOrderBy\PivotSelection>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|