PurgeUserEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Request message for PurgeUserEvents method.
Attributes |
|
|---|---|
| Name | Description |
parent |
str
Required. The resource name of the event_store under which the events are created. The format is projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}
|
filter |
str
Required. The filter string to specify the events to be deleted. Empty string filter is not allowed. This filter can also be used with ListUserEvents API to list events that will be deleted. The eligible fields for filtering are: - eventType - UserEvent.eventType field of type string. - eventTime - in ISO 8601 "zulu" format. - visitorId - field of type string. Specifying this will delete all events associated with a visitor. - userId - field of type string. Specifying this will delete all events associated with a user. Example 1: Deleting all events in a time range. eventTime > "2012-04-23T18:25:43.511Z" eventTime <>
Example 2: Deleting specific eventType in time range.
eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"
Example 3: Deleting all events for a specific visitor
visitorId = visitor1024 The filtering fields are
assumed to have an implicit AND.
|
force |
bool
Optional. The default value is false. Override this flag to true to actually perform the purge. If the field is not set to true, a sampling of events to be deleted will be returned. |