- Resource: SubpropertyEventFilter
- SubpropertyEventFilterClause
- FilterClauseType
- SubpropertyEventFilterExpression
- SubpropertyEventFilterExpressionList
- SubpropertyEventFilterCondition
- StringFilter
- MatchType
- Methods
Resource: SubpropertyEventFilter
A resource message representing a GA4 Subproperty event filter.
JSON representation |
---|
{
"name": string,
"filterClauses": [
{
object ( |
Fields | |
---|---|
name |
Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678 |
filterClauses[] |
Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND'ed together to determine what data is sent to the subproperty. |
applyToProperty |
Immutable. Resource name of the Subproperty that uses this filter. |
SubpropertyEventFilterClause
A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty's data) or exclusive (events satisfying the filter clause are excluded from the subproperty's data).
JSON representation |
---|
{ "filterClauseType": enum ( |
Fields | |
---|---|
filterClauseType |
Required. The type for the filter clause. |
filterExpression |
Required. The logical expression for what events are sent to the subproperty. |
FilterClauseType
Specifies whether this is an include or exclude filter clause.
Enums | |
---|---|
FILTER_CLAUSE_TYPE_UNSPECIFIED |
Filter clause type unknown or not specified. |
INCLUDE |
Events will be included in the Sub property if the filter clause is met. |
EXCLUDE |
Events will be excluded from the Sub property if the filter clause is met. |
SubpropertyEventFilterExpression
A logical expression of Subproperty event filters.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field expr . The expression applied to a filter. expr can be only one of the following: |
|
orGroup |
A list of expressions to OR’ed together. Must only contain notExpression or filterCondition expressions. |
notExpression |
A filter expression to be NOT'ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression. |
filterCondition |
Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression. |
SubpropertyEventFilterExpressionList
A list of Subproperty event filter expressions.
JSON representation |
---|
{
"filterExpressions": [
{
object ( |
Fields | |
---|---|
filterExpressions[] |
Required. Unordered list. A list of Subproperty event filter expressions |
SubpropertyEventFilterCondition
A specific filter expression
JSON representation |
---|
{ "fieldName": string, // Union field |
Fields | |
---|---|
fieldName |
Required. The field that is being filtered. |
Union field
|
|
nullFilter |
A filter for null values. |
stringFilter |
A filter for a string-type dimension that matches a particular pattern. |
StringFilter
A filter for a string-type dimension that matches a particular pattern.
JSON representation |
---|
{
"matchType": enum ( |
Fields | |
---|---|
matchType |
Required. The match type for the string filter. |
value |
Required. The string value used for the matching. |
caseSensitive |
Optional. If true, the string value is case sensitive. If false, the match is case-insensitive. |
MatchType
How the filter will be used to determine a match.
Enums | |
---|---|
MATCH_TYPE_UNSPECIFIED |
Match type unknown or not specified. |
EXACT |
Exact match of the string value. |
BEGINS_WITH |
Begins with the string value. |
ENDS_WITH |
Ends with the string value. |
CONTAINS |
Contains the string value. |
FULL_REGEXP |
Full regular expression matches with the string value. |
PARTIAL_REGEXP |
Partial regular expression matches with the string value. |
Methods |
|
---|---|
|
Creates a subproperty Event Filter. |
|
Deletes a subproperty event filter. |
|
Lookup for a single subproperty Event Filter. |
|
List all subproperty Event Filters on a property. |
|
Updates a subproperty Event Filter. |