Class PurgeUserEventsRequest (2.5.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version latestkeyboard_arrow_down
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/catalogs/${catalogId}
filter
str
Required. The filter string to specify the events to be
deleted with a length limit of 5,000 characters. Empty
string filter is not allowed. The eligible fields for
filtering are:
- eventType
: Double quoted
UserEvent.event_type
string.
- eventTime
: in ISO 8601 "zulu" format.
- visitorId
: 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 in time range:
eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"
- Deleting all events for a specific visitor:
visitorId = "visitor1024"
The filtering fields are assumed to have an implicit AND.
force
bool
Actually perform the purge. If force
is set to false,
the method will return the expected purge count without
deleting any user events.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class PurgeUserEventsRequest (2.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.5.0 (latest)](/python/docs/reference/retail/latest/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [2.4.0](/python/docs/reference/retail/2.4.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [2.3.0](/python/docs/reference/retail/2.3.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [2.2.0](/python/docs/reference/retail/2.2.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [2.1.0](/python/docs/reference/retail/2.1.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [2.0.0](/python/docs/reference/retail/2.0.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.25.0](/python/docs/reference/retail/1.25.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.24.0](/python/docs/reference/retail/1.24.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.23.1](/python/docs/reference/retail/1.23.1/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.22.0](/python/docs/reference/retail/1.22.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.21.2](/python/docs/reference/retail/1.21.2/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.20.1](/python/docs/reference/retail/1.20.1/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.19.1](/python/docs/reference/retail/1.19.1/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.18.0](/python/docs/reference/retail/1.18.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.17.0](/python/docs/reference/retail/1.17.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.16.3](/python/docs/reference/retail/1.16.3/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.15.1](/python/docs/reference/retail/1.15.1/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.14.1](/python/docs/reference/retail/1.14.1/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.13.0](/python/docs/reference/retail/1.13.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.12.0](/python/docs/reference/retail/1.12.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.11.0](/python/docs/reference/retail/1.11.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.10.2](/python/docs/reference/retail/1.10.2/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.9.0](/python/docs/reference/retail/1.9.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.8.1](/python/docs/reference/retail/1.8.1/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.7.0](/python/docs/reference/retail/1.7.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.6.1](/python/docs/reference/retail/1.6.1/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.5.0](/python/docs/reference/retail/1.5.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.4.1](/python/docs/reference/retail/1.4.1/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.3.0](/python/docs/reference/retail/1.3.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.2.1](/python/docs/reference/retail/1.2.1/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.1.0](/python/docs/reference/retail/1.1.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [1.0.2](/python/docs/reference/retail/1.0.2/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [0.4.2](/python/docs/reference/retail/0.4.2/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [0.3.1](/python/docs/reference/retail/0.3.1/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [0.2.0](/python/docs/reference/retail/0.2.0/google.cloud.retail_v2.types.PurgeUserEventsRequest)\n- [0.1.0](/python/docs/reference/retail/0.1.0/google.cloud.retail_v2.types.PurgeUserEventsRequest) \n\n PurgeUserEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nRequest message for PurgeUserEvents method."]]