Google Analytics Data V1alpha Client - Class SegmentFilter (0.19.0)

Reference documentation and code samples for the Google Analytics Data V1alpha Client class SegmentFilter.

An expression to filter dimension or metric values.

Generated from protobuf message google.analytics.data.v1alpha.SegmentFilter

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ field_name string

The dimension name or metric name.

↳ string_filter Google\Analytics\Data\V1alpha\StringFilter

Strings related filter.

↳ in_list_filter Google\Analytics\Data\V1alpha\InListFilter

A filter for in list values.

↳ numeric_filter Google\Analytics\Data\V1alpha\NumericFilter

A filter for numeric or date values.

↳ between_filter Google\Analytics\Data\V1alpha\BetweenFilter

A filter for between two values.

↳ filter_scoping Google\Analytics\Data\V1alpha\SegmentFilterScoping

Specifies the scope for the filter.

getFieldName

The dimension name or metric name.

Returns
Type Description
string

setFieldName

The dimension name or metric name.

Parameter
Name Description
var string
Returns
Type Description
$this

getStringFilter

Strings related filter.

Returns
Type Description
Google\Analytics\Data\V1alpha\StringFilter|null

hasStringFilter

setStringFilter

Strings related filter.

Parameter
Name Description
var Google\Analytics\Data\V1alpha\StringFilter
Returns
Type Description
$this

getInListFilter

A filter for in list values.

Returns
Type Description
Google\Analytics\Data\V1alpha\InListFilter|null

hasInListFilter

setInListFilter

A filter for in list values.

Parameter
Name Description
var Google\Analytics\Data\V1alpha\InListFilter
Returns
Type Description
$this

getNumericFilter

A filter for numeric or date values.

Returns
Type Description
Google\Analytics\Data\V1alpha\NumericFilter|null

hasNumericFilter

setNumericFilter

A filter for numeric or date values.

Parameter
Name Description
var Google\Analytics\Data\V1alpha\NumericFilter
Returns
Type Description
$this

getBetweenFilter

A filter for between two values.

Returns
Type Description
Google\Analytics\Data\V1alpha\BetweenFilter|null

hasBetweenFilter

setBetweenFilter

A filter for between two values.

Parameter
Name Description
var Google\Analytics\Data\V1alpha\BetweenFilter
Returns
Type Description
$this

getFilterScoping

Specifies the scope for the filter.

Returns
Type Description
Google\Analytics\Data\V1alpha\SegmentFilterScoping|null

hasFilterScoping

clearFilterScoping

setFilterScoping

Specifies the scope for the filter.

Parameter
Name Description
var Google\Analytics\Data\V1alpha\SegmentFilterScoping
Returns
Type Description
$this

getOneFilter

Returns
Type Description
string