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 \ V1alphaMethods
__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 |
StringFilter
Strings related filter. |
↳ in_list_filter |
InListFilter
A filter for in list values. |
↳ numeric_filter |
NumericFilter
A filter for numeric or date values. |
↳ between_filter |
BetweenFilter
A filter for between two values. |
↳ filter_scoping |
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 |
StringFilter|null |
|
hasStringFilter
setStringFilter
Strings related filter.
| Parameter | |
|---|---|
| Name | Description |
var |
StringFilter
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInListFilter
A filter for in list values.
| Returns | |
|---|---|
| Type | Description |
InListFilter|null |
|
hasInListFilter
setInListFilter
A filter for in list values.
| Parameter | |
|---|---|
| Name | Description |
var |
InListFilter
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNumericFilter
A filter for numeric or date values.
| Returns | |
|---|---|
| Type | Description |
NumericFilter|null |
|
hasNumericFilter
setNumericFilter
A filter for numeric or date values.
| Parameter | |
|---|---|
| Name | Description |
var |
NumericFilter
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBetweenFilter
A filter for between two values.
| Returns | |
|---|---|
| Type | Description |
BetweenFilter|null |
|
hasBetweenFilter
setBetweenFilter
A filter for between two values.
| Parameter | |
|---|---|
| Name | Description |
var |
BetweenFilter
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilterScoping
Specifies the scope for the filter.
| Returns | |
|---|---|
| Type | Description |
SegmentFilterScoping|null |
|
hasFilterScoping
clearFilterScoping
setFilterScoping
Specifies the scope for the filter.
| Parameter | |
|---|---|
| Name | Description |
var |
SegmentFilterScoping
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOneFilter
| Returns | |
|---|---|
| Type | Description |
string |
|