Google Analytics Data V1beta Client - Class Filter (0.10.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
NameDescription
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 Google\Analytics\Data\V1beta\Filter\StringFilter

Strings related filter.

↳ in_list_filter Google\Analytics\Data\V1beta\Filter\InListFilter

A filter for in list values.

↳ numeric_filter Google\Analytics\Data\V1beta\Filter\NumericFilter

A filter for numeric or date values.

↳ between_filter Google\Analytics\Data\V1beta\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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getStringFilter

Strings related filter.

Returns
TypeDescription
Google\Analytics\Data\V1beta\Filter\StringFilter|null

hasStringFilter

setStringFilter

Strings related filter.

Parameter
NameDescription
var Google\Analytics\Data\V1beta\Filter\StringFilter
Returns
TypeDescription
$this

getInListFilter

A filter for in list values.

Returns
TypeDescription
Google\Analytics\Data\V1beta\Filter\InListFilter|null

hasInListFilter

setInListFilter

A filter for in list values.

Parameter
NameDescription
var Google\Analytics\Data\V1beta\Filter\InListFilter
Returns
TypeDescription
$this

getNumericFilter

A filter for numeric or date values.

Returns
TypeDescription
Google\Analytics\Data\V1beta\Filter\NumericFilter|null

hasNumericFilter

setNumericFilter

A filter for numeric or date values.

Parameter
NameDescription
var Google\Analytics\Data\V1beta\Filter\NumericFilter
Returns
TypeDescription
$this

getBetweenFilter

A filter for two values.

Returns
TypeDescription
Google\Analytics\Data\V1beta\Filter\BetweenFilter|null

hasBetweenFilter

setBetweenFilter

A filter for two values.

Parameter
NameDescription
var Google\Analytics\Data\V1beta\Filter\BetweenFilter
Returns
TypeDescription
$this

getOneFilter

Returns
TypeDescription
string