Class GoogleCloudRetailV2alphaPurgeUserEventsRequest
Request message for PurgeUserEvents method.
Implements
Inherited Members
Namespace: Google.Apis.CloudRetail.v2alpha.Data
Assembly: Google.Apis.CloudRetail.v2alpha.dll
Syntax
public class GoogleCloudRetailV2alphaPurgeUserEventsRequest : IDirectResponseSchema
Properties
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
Filter
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 < "2012-04-23T18:30:43.511Z"
*
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.
Declaration
[JsonProperty("filter")]
public virtual string Filter { get; set; }
Property Value
Type | Description |
---|---|
string |
Force
Actually perform the purge. If force
is set to false, the method will return the expected purge count
without deleting any user events.
Declaration
[JsonProperty("force")]
public virtual bool? Force { get; set; }
Property Value
Type | Description |
---|---|
bool? |