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 messagegoogle.analytics.data.v1alpha.SegmentParameterFilter
Namespace
Google \ Analytics \ Data \ V1alpha
Methods
__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 theMeasure ecommerceguide.
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 theMeasure ecommerceguide.
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 theMeasure ecommerceguide.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Analytics Data V1alpha Client - Class SegmentParameterFilter (0.22.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.22.3 (latest)](/php/docs/reference/analytics-data/latest/V1alpha.SegmentParameterFilter)\n- [0.22.2](/php/docs/reference/analytics-data/0.22.2/V1alpha.SegmentParameterFilter)\n- [0.21.1](/php/docs/reference/analytics-data/0.21.1/V1alpha.SegmentParameterFilter)\n- [0.20.1](/php/docs/reference/analytics-data/0.20.1/V1alpha.SegmentParameterFilter)\n- [0.19.0](/php/docs/reference/analytics-data/0.19.0/V1alpha.SegmentParameterFilter)\n- [0.18.0](/php/docs/reference/analytics-data/0.18.0/V1alpha.SegmentParameterFilter)\n- [0.17.1](/php/docs/reference/analytics-data/0.17.1/V1alpha.SegmentParameterFilter)\n- [0.16.4](/php/docs/reference/analytics-data/0.16.4/V1alpha.SegmentParameterFilter)\n- [0.14.0](/php/docs/reference/analytics-data/0.14.0/V1alpha.SegmentParameterFilter)\n- [0.13.0](/php/docs/reference/analytics-data/0.13.0/V1alpha.SegmentParameterFilter)\n- [0.12.0](/php/docs/reference/analytics-data/0.12.0/V1alpha.SegmentParameterFilter)\n- [0.11.2](/php/docs/reference/analytics-data/0.11.2/V1alpha.SegmentParameterFilter)\n- [0.10.1](/php/docs/reference/analytics-data/0.10.1/V1alpha.SegmentParameterFilter)\n- [0.9.5](/php/docs/reference/analytics-data/0.9.5/V1alpha.SegmentParameterFilter) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Analytics Data V1alpha Client class SegmentParameterFilter.\n\nAn expression to filter parameter values in a segment.\n\nGenerated from protobuf message `google.analytics.data.v1alpha.SegmentParameterFilter`\n\nNamespace\n---------\n\nGoogle \\\\ Analytics \\\\ Data \\\\ V1alpha\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getEventParameterName\n\nThis filter will be evaluated on the specified event parameter. Event\nparameters are logged as parameters of the event. Event parameters\ninclude fields like \"firebase_screen\" \\& \"currency\".\n\nEvent parameters can only be used in segments \\& funnels and can only be\nused in a descendent filter from an EventFilter. In a descendent filter\nfrom an EventFilter either event or item parameters should be used.\n\n### hasEventParameterName\n\n### setEventParameterName\n\nThis filter will be evaluated on the specified event parameter. Event\nparameters are logged as parameters of the event. Event parameters\ninclude fields like \"firebase_screen\" \\& \"currency\".\n\nEvent parameters can only be used in segments \\& funnels and can only be\nused in a descendent filter from an EventFilter. In a descendent filter\nfrom an EventFilter either event or item parameters should be used.\n\n### getItemParameterName\n\nThis filter will be evaluated on the specified item parameter. Item\nparameters are logged as parameters in the item array. Item parameters\ninclude fields like \"item_name\" \\& \"item_category\".\n\nItem parameters can only be used in segments \\& funnels and can only be\nused in a descendent filter from an EventFilter. In a descendent filter\nfrom an EventFilter either event or item parameters should be used.\nItem parameters are only available in ecommerce events. To learn more\nabout ecommerce events, see the [Measure ecommerce](https://developers.google.com/analytics/devguides/collection/ga4/ecommerce)\nguide.\n\n### hasItemParameterName\n\n### setItemParameterName\n\nThis filter will be evaluated on the specified item parameter. Item\nparameters are logged as parameters in the item array. Item parameters\ninclude fields like \"item_name\" \\& \"item_category\".\n\nItem parameters can only be used in segments \\& funnels and can only be\nused in a descendent filter from an EventFilter. In a descendent filter\nfrom an EventFilter either event or item parameters should be used.\nItem parameters are only available in ecommerce events. To learn more\nabout ecommerce events, see the [Measure ecommerce](https://developers.google.com/analytics/devguides/collection/ga4/ecommerce)\nguide.\n\n### getStringFilter\n\nStrings related filter.\n\n### hasStringFilter\n\n### setStringFilter\n\nStrings related filter.\n\n### getInListFilter\n\nA filter for in list values.\n\n### hasInListFilter\n\n### setInListFilter\n\nA filter for in list values.\n\n### getNumericFilter\n\nA filter for numeric or date values.\n\n### hasNumericFilter\n\n### setNumericFilter\n\nA filter for numeric or date values.\n\n### getBetweenFilter\n\nA filter for between two values.\n\n### hasBetweenFilter\n\n### setBetweenFilter\n\nA filter for between two values.\n\n### getFilterScoping\n\nSpecifies the scope for the filter.\n\n### hasFilterScoping\n\n### clearFilterScoping\n\n### setFilterScoping\n\nSpecifies the scope for the filter.\n\n### getOneParameter\n\n### getOneFilter"]]
