Google Analytics Data V1beta Client - Class Filter (0.20.1)

Reference documentation and code samples for the Google Analytics Data V1beta Client class Filter.

An expression to filter dimension or metric values.

Generated from protobuf message google.analytics.data.v1beta.Filter

Namespace

Google \ Analytics \ Data \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ field_name string

The dimension name or metric name. In most methods, dimensions & metrics can be used for the first time in this field. However in a RunPivotReportRequest, this field must be additionally specified by name in the RunPivotReportRequest's dimensions or metrics.

↳ string_filter Filter\StringFilter

Strings related filter.

↳ in_list_filter Filter\InListFilter

A filter for in list values.

↳ numeric_filter Filter\NumericFilter

A filter for numeric or date values.

↳ between_filter Filter\BetweenFilter

A filter for two values.

getFieldName

The dimension name or metric name.

In most methods, dimensions & metrics can be used for the first time in this field. However in a RunPivotReportRequest, this field must be additionally specified by name in the RunPivotReportRequest's dimensions or metrics.

Returns
Type Description
string

setFieldName

The dimension name or metric name.

In most methods, dimensions & metrics can be used for the first time in this field. However in a RunPivotReportRequest, this field must be additionally specified by name in the RunPivotReportRequest's dimensions or metrics.

Parameter
Name Description
var string
Returns
Type Description
$this

getStringFilter

Strings related filter.

Returns
Type Description
Filter\StringFilter|null

hasStringFilter

setStringFilter

Strings related filter.

Parameter
Name Description
var Filter\StringFilter
Returns
Type Description
$this

getInListFilter

A filter for in list values.

Returns
Type Description
Filter\InListFilter|null

hasInListFilter

setInListFilter

A filter for in list values.

Parameter
Name Description
var Filter\InListFilter
Returns
Type Description
$this

getNumericFilter

A filter for numeric or date values.

Returns
Type Description
Filter\NumericFilter|null

hasNumericFilter

setNumericFilter

A filter for numeric or date values.

Parameter
Name Description
var Filter\NumericFilter
Returns
Type Description
$this

getBetweenFilter

A filter for two values.

Returns
Type Description
Filter\BetweenFilter|null

hasBetweenFilter

setBetweenFilter

A filter for two values.

Parameter
Name Description
var Filter\BetweenFilter
Returns
Type Description
$this

getOneFilter

Returns
Type Description
string