Reference documentation and code samples for the Google Analytics Data V1beta Client class OrderBy.
Order bys define how rows will be sorted in the response. For example, ordering rows by descending event count is one ordering, and ordering rows by the event name string is a different ordering.
Generated from protobuf message google.analytics.data.v1beta.OrderBy
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ metric |
Google\Analytics\Data\V1beta\OrderBy\MetricOrderBy
Sorts results by a metric's values. |
↳ dimension |
Google\Analytics\Data\V1beta\OrderBy\DimensionOrderBy
Sorts results by a dimension's values. |
↳ pivot |
Google\Analytics\Data\V1beta\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\V1beta\OrderBy\MetricOrderBy|null | |
hasMetric
setMetric
Sorts results by a metric's values.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Analytics\Data\V1beta\OrderBy\MetricOrderBy
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDimension
Sorts results by a dimension's values.
| Returns | |
|---|---|
| Type | Description |
Google\Analytics\Data\V1beta\OrderBy\DimensionOrderBy|null | |
hasDimension
setDimension
Sorts results by a dimension's values.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Analytics\Data\V1beta\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\V1beta\OrderBy\PivotOrderBy|null | |
hasPivot
setPivot
Sorts results by a metric's values within a pivot column group.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Analytics\Data\V1beta\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 | |