0.20.1 (latest) 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.12 0.12.3 0.11.14 0.10.0 0.9.1 0.8.1 0.7.0 0.6.0 0.5.0 0.4.1 0.3.1 0.2.1 0.1.1

    PurgeUserEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for PurgeUserEvents method.

| ## Attributes ||
|---|---|
| **Name** | **Description** |
| `parent` | `str` Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` |
| `filter` | `str` Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: - `eventType`: Double quoted UserEvent.event_type string. - `eventTime`: in ISO 8601 "zulu" format. - `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. - `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: - Deleting all events in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime <>` - Deleting specific eventType: `eventType = "search"` - Deleting all events for a specific visitor: `userPseudoId = "visitor1024"` - Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND. |
| `force` | `bool` The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request. |