Method: projects.locations.dataStores.userEvents.purge

Löscht alle Nutzerereignisse, die durch den angegebenen Filter definiert werden, dauerhaft. Je nach Anzahl der im Filter angegebenen Ereignisse kann es Stunden oder Tage dauern, bis dieser Vorgang abgeschlossen ist. Verwenden Sie zuerst den Befehl „list“, um einen Filter zu testen.

HTTP-Anfrage

POST https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/dataStores/*}/userEvents:purge

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname des Katalogs, unter dem die Ereignisse erstellt werden. Das Format dafür ist projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "filter": string,
  "force": boolean
}
Felder
filter

string

Erforderlich. Der Filterstring zum Angeben der zu löschenden Ereignisse. Die Länge ist auf 5.000 Zeichen begrenzt. Folgende Felder können gefiltert werden:

  • eventType: UserEvent.event_type-String in doppelten Anführungszeichen.
  • eventTime: im ISO-8601-Format „Zulu“.
  • userPseudoId: String in doppelten Anführungszeichen. Bei Angabe dieses Attributs werden alle mit einem Besucher verknüpften Ereignisse gelöscht.
  • userId: String in doppelten Anführungszeichen. Bei Angabe dieses Attributs werden alle mit einem Nutzer verknüpften Ereignisse gelöscht.

Hinweis: Mit dieser API können Daten für maximal 30 Tage gelöscht werden.

Beispiele:

  • Alle Termine in einem Zeitraum löschen: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
  • Bestimmte eventType in einem Zeitraum löschen: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
  • Alle Ereignisse für einen bestimmten Besucher in einem Zeitraum löschen: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
  • Löschen der Ereignisse der letzten 30 Tage in einem DataStore: *

Bei den Filterfeldern wird von einer impliziten UND-Verknüpfung ausgegangen.

force

boolean

Das Feld force wird derzeit nicht unterstützt. Bei Anfragen zum dauerhaften Löschen von Nutzerereignissen werden alle löschbaren Ereignisse dauerhaft gelöscht. Nach Abschluss der Entwicklung: Wenn force auf „false“ gesetzt ist, gibt die Methode die erwartete Anzahl an Löschungen zurück, ohne Nutzerereignisse zu löschen. Dieses Feld wird standardmäßig auf „false“ gesetzt, wenn es nicht in der Anfrage enthalten ist.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • discoveryengine.userEvents.purge

Weitere Informationen finden Sie in der IAM-Dokumentation.