Reference documentation and code samples for the Google Analytics Data V1alpha Client class SegmentParameterFilter.
An expression to filter parameter values in a segment.
Generated from protobuf message google.analytics.data.v1alpha.SegmentParameterFilter
Namespace
Google \ Analytics \ Data \ V1alphaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ event_parameter_name |
string
This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like "firebase_screen" & "currency". Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used. |
↳ item_parameter_name |
string
This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like "item_name" & "item_category". Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used. Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the Measure ecommerce guide. |
↳ 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 |
SegmentParameterFilterScoping
Specifies the scope for the filter. |
getEventParameterName
This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like "firebase_screen" & "currency".
Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasEventParameterName
setEventParameterName
This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like "firebase_screen" & "currency".
Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getItemParameterName
This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like "item_name" & "item_category".
Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used. Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the Measure ecommerce guide.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasItemParameterName
setItemParameterName
This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like "item_name" & "item_category".
Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used. Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the Measure ecommerce guide.
| 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 |
SegmentParameterFilterScoping|null |
|
hasFilterScoping
clearFilterScoping
setFilterScoping
Specifies the scope for the filter.
| Parameter | |
|---|---|
| Name | Description |
var |
SegmentParameterFilterScoping
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOneParameter
| Returns | |
|---|---|
| Type | Description |
string |
|
getOneFilter
| Returns | |
|---|---|
| Type | Description |
string |
|