View Source GoogleApi.Retail.V2.Model.GoogleCloudRetailV2PurgeUserEventsRequest (google_api_retail v0.19.1)

Request message for PurgeUserEvents method.

Attributes

  • filter (type: String.t, default: nil) - 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.
  • force (type: boolean(), default: nil) - Actually perform the purge. If force is set to false, the method will return the expected purge count without deleting any user events.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Retail.V2.Model.GoogleCloudRetailV2PurgeUserEventsRequest{
  filter: String.t() | nil,
  force: boolean() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.