Reference documentation and code samples for the Google Analytics Data V1alpha Client class Filter.
An expression to filter dimension or metric values.
Generated from protobuf message google.analytics.data.v1alpha.Filter
Namespace
Google \ Analytics \ Data \ V1alphaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ field_name |
string
The dimension name or metric name. Must be a name defined in dimensions or metrics. |
↳ null_filter |
bool
A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null. |
↳ string_filter |
Google\Analytics\Data\V1alpha\Filter\StringFilter
Strings related filter. |
↳ in_list_filter |
Google\Analytics\Data\V1alpha\Filter\InListFilter
A filter for in list values. |
↳ numeric_filter |
Google\Analytics\Data\V1alpha\Filter\NumericFilter
A filter for numeric or date values. |
↳ between_filter |
Google\Analytics\Data\V1alpha\Filter\BetweenFilter
A filter for two values. |
getFieldName
The dimension name or metric name. Must be a name defined in dimensions or metrics.
| Returns | |
|---|---|
| Type | Description |
string | |
setFieldName
The dimension name or metric name. Must be a name defined in dimensions or metrics.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNullFilter
A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasNullFilter
setNullFilter
A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStringFilter
Strings related filter.
| Returns | |
|---|---|
| Type | Description |
Google\Analytics\Data\V1alpha\Filter\StringFilter|null | |
hasStringFilter
setStringFilter
Strings related filter.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Analytics\Data\V1alpha\Filter\StringFilter
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInListFilter
A filter for in list values.
| Returns | |
|---|---|
| Type | Description |
Google\Analytics\Data\V1alpha\Filter\InListFilter|null | |
hasInListFilter
setInListFilter
A filter for in list values.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Analytics\Data\V1alpha\Filter\InListFilter
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNumericFilter
A filter for numeric or date values.
| Returns | |
|---|---|
| Type | Description |
Google\Analytics\Data\V1alpha\Filter\NumericFilter|null | |
hasNumericFilter
setNumericFilter
A filter for numeric or date values.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Analytics\Data\V1alpha\Filter\NumericFilter
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBetweenFilter
A filter for two values.
| Returns | |
|---|---|
| Type | Description |
Google\Analytics\Data\V1alpha\Filter\BetweenFilter|null | |
hasBetweenFilter
setBetweenFilter
A filter for two values.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Analytics\Data\V1alpha\Filter\BetweenFilter
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOneFilter
| Returns | |
|---|---|
| Type | Description |
string | |