Google Analytics Admin V1alpha Client - Class AccessOrderBy (0.18.1)

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class AccessOrderBy.

Order bys define how rows will be sorted in the response. For example, ordering rows by descending access count is one ordering, and ordering rows by the country string is a different ordering.

Generated from protobuf message google.analytics.admin.v1alpha.AccessOrderBy

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ metric`	`Google\Analytics\Admin\V1alpha\AccessOrderBy\MetricOrderBy` Sorts results by a metric's values.
`↳ dimension`	`Google\Analytics\Admin\V1alpha\AccessOrderBy\DimensionOrderBy` Sorts results by a dimension's values.
`↳ desc`	`bool` If true, sorts by descending order. If false or unspecified, sorts in ascending order.

getMetric

Sorts results by a metric's values.

Returns
Type	Description
`Google\Analytics\Admin\V1alpha\AccessOrderBy\MetricOrderBy\|null`

hasMetric

setMetric

Sorts results by a metric's values.

Parameter
Name	Description
`var`	`Google\Analytics\Admin\V1alpha\AccessOrderBy\MetricOrderBy`

Returns
Type	Description
`$this`

getDimension

Sorts results by a dimension's values.

Returns
Type	Description
`Google\Analytics\Admin\V1alpha\AccessOrderBy\DimensionOrderBy\|null`

hasDimension

setDimension

Sorts results by a dimension's values.

Parameter
Name	Description
`var`	`Google\Analytics\Admin\V1alpha\AccessOrderBy\DimensionOrderBy`

Returns
Type	Description
`$this`

getDesc

If true, sorts by descending order. If false or unspecified, sorts in ascending order.

Returns
Type	Description
`bool`

setDesc

If true, sorts by descending order. If false or unspecified, sorts in ascending order.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getOneOrderBy

Returns
Type	Description
`string`