Reference documentation and code samples for the Google Analytics Data V1alpha Client class OrderBy.
The sort options.
Generated from protobuf message google.analytics.data.v1alpha.OrderBy
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ metric |
Google\Analytics\Data\V1alpha\OrderBy\MetricOrderBy
Sorts results by a metric's values. |
↳ dimension |
Google\Analytics\Data\V1alpha\OrderBy\DimensionOrderBy
Sorts results by a dimension's values. |
↳ pivot |
Google\Analytics\Data\V1alpha\OrderBy\PivotOrderBy
Sorts results by a metric's values within a pivot column group. |
↳ desc |
bool
If true, sorts by descending order. |
getMetric
Sorts results by a metric's values.
| Returns | |
|---|---|
| Type | Description |
Google\Analytics\Data\V1alpha\OrderBy\MetricOrderBy|null | |
hasMetric
setMetric
Sorts results by a metric's values.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Analytics\Data\V1alpha\OrderBy\MetricOrderBy
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDimension
Sorts results by a dimension's values.
| Returns | |
|---|---|
| Type | Description |
Google\Analytics\Data\V1alpha\OrderBy\DimensionOrderBy|null | |
hasDimension
setDimension
Sorts results by a dimension's values.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Analytics\Data\V1alpha\OrderBy\DimensionOrderBy
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPivot
Sorts results by a metric's values within a pivot column group.
| Returns | |
|---|---|
| Type | Description |
Google\Analytics\Data\V1alpha\OrderBy\PivotOrderBy|null | |
hasPivot
setPivot
Sorts results by a metric's values within a pivot column group.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Analytics\Data\V1alpha\OrderBy\PivotOrderBy
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDesc
If true, sorts by descending order.
| Returns | |
|---|---|
| Type | Description |
bool | |
setDesc
If true, sorts by descending order.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOneOrderBy
| Returns | |
|---|---|
| Type | Description |
string | |