# REST Resource: properties.subpropertyEventFilters

- [Resource: SubpropertyEventFilter](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilter)
  - [JSON representation](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilter.SCHEMA_REPRESENTATION)
- [SubpropertyEventFilterClause](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterClause)
  - [JSON representation](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterClause.SCHEMA_REPRESENTATION)
- [FilterClauseType](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#FilterClauseType)
- [SubpropertyEventFilterExpression](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterExpression)
  - [JSON representation](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterExpression.SCHEMA_REPRESENTATION)
- [SubpropertyEventFilterExpressionList](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterExpressionList)
  - [JSON representation](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterExpressionList.SCHEMA_REPRESENTATION)
- [SubpropertyEventFilterCondition](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterCondition)
  - [JSON representation](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterCondition.SCHEMA_REPRESENTATION)
- [StringFilter](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#StringFilter)
  - [JSON representation](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#StringFilter.SCHEMA_REPRESENTATION)
- [MatchType](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#MatchType)
- [Methods](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#METHODS_SUMMARY)

## Resource: SubpropertyEventFilter

A resource message representing a Google Analytics subproperty event filter.

| JSON representation |
|---|
| ``` { "name": string, "filterClauses": [ { object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterClause`) } ], "applyToProperty": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678 |
| `filterClauses[]` | ``object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterClause`)`` 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` | `string` 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 (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#FilterClauseType`), "filterExpression": { object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterExpression`) } } ``` |

| Fields ||
|---|---|
| `filterClauseType` | ``enum (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#FilterClauseType`)`` Required. The type for the filter clause. |
| `filterExpression` | ``object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterExpression`)`` 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 `expr` can be only one of the following: "orGroup": { object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterExpressionList`) }, "notExpression": { object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterExpression`) }, "filterCondition": { object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterCondition`) } // End of list of possible types for union field `expr`. } ``` |

| Fields ||
|---|---|
| Union field `expr`. The expression applied to a filter. `expr` can be only one of the following: ||
| `orGroup` | ``object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterExpressionList`)`` A list of expressions to OR'ed together. Must only contain notExpression or filterCondition expressions. |
| `notExpression` | ``object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterExpression`)`` 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` | ``object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterCondition`)`` 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 (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterExpression`) } ] } ``` |

| Fields ||
|---|---|
| `filterExpressions[]` | ``object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilterExpression`)`` Required. Unordered list. A list of Subproperty event filter expressions |

## SubpropertyEventFilterCondition

A specific filter expression

| JSON representation |
|---|
| ``` { "fieldName": string, // Union field `one_filter` can be only one of the following: "nullFilter": boolean, "stringFilter": { object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#StringFilter`) } // End of list of possible types for union field `one_filter`. } ``` |

| Fields ||
|---|---|
| `fieldName` | `string` Required. The field that is being filtered. |
| Union field `one_filter`. `one_filter` can be only one of the following: ||
| `nullFilter` | `boolean` A filter for null values. |
| `stringFilter` | ``object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#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 (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#MatchType`), "value": string, "caseSensitive": boolean } ``` |

| Fields ||
|---|---|
| `matchType` | ``enum (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#MatchType`)`` Required. The match type for the string filter. |
| `value` | `string` Required. The string value used for the matching. |
| `caseSensitive` | `boolean` 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 ||
|---|---|
| ### `https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters/create` | Creates a subproperty Event Filter. |
| ### `https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters/delete` | Deletes a subproperty event filter. |
| ### `https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters/get` | Lookup for a single subproperty Event Filter. |
| ### `https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters/list` | List all subproperty Event Filters on a property. |
| ### `https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters/patch` | Updates a subproperty Event Filter. |