Google Analytics Data V1alpha Client - Class OrderBy (0.9.5)

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
NameDescription
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
TypeDescription
Google\Analytics\Data\V1alpha\OrderBy\MetricOrderBy|null

hasMetric

setMetric

Sorts results by a metric's values.

Parameter
NameDescription
var Google\Analytics\Data\V1alpha\OrderBy\MetricOrderBy
Returns
TypeDescription
$this

getDimension

Sorts results by a dimension's values.

Returns
TypeDescription
Google\Analytics\Data\V1alpha\OrderBy\DimensionOrderBy|null

hasDimension

setDimension

Sorts results by a dimension's values.

Parameter
NameDescription
var Google\Analytics\Data\V1alpha\OrderBy\DimensionOrderBy
Returns
TypeDescription
$this

getPivot

Sorts results by a metric's values within a pivot column group.

Returns
TypeDescription
Google\Analytics\Data\V1alpha\OrderBy\PivotOrderBy|null

hasPivot

setPivot

Sorts results by a metric's values within a pivot column group.

Parameter
NameDescription
var Google\Analytics\Data\V1alpha\OrderBy\PivotOrderBy
Returns
TypeDescription
$this

getDesc

If true, sorts by descending order.

Returns
TypeDescription
bool

setDesc

If true, sorts by descending order.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getOneOrderBy

Returns
TypeDescription
string