Method: projects.locations.dataStores.userEvents.purge

Elimina definitivamente tutti gli eventi utente specificati dal filtro fornito. A seconda del numero di eventi specificati dal filtro, il completamento di questa operazione potrebbe richiedere ore o giorni. Per testare un filtro, utilizza prima il comando list.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa del catalogo in cui vengono creati gli eventi. Il formato è projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "filter": string,
  "force": boolean
}
Campi
filter

string

Obbligatorio. La stringa di filtro per specificare gli eventi da eliminare con un limite di 5000 caratteri. I campi idonei per il filtro sono:

  • eventType: stringa UserEvent.event_type tra virgolette doppie.
  • eventTime: in formato ISO 8601 "zulu".
  • userPseudoId: stringa tra virgolette doppie. Se specifichi questa opzione, verranno eliminati tutti gli eventi associati a un visitatore.
  • userId: stringa tra virgolette doppie. Se specifichi questa opzione, vengono eliminati tutti gli eventi associati a un utente.

Nota: questa API supporta solo l'eliminazione di un intervallo massimo di 30 giorni.

Esempi:

  • Eliminazione di tutti gli eventi in un intervallo di tempo: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
  • Eliminazione di un tipo di evento specifico in un intervallo di tempo: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
  • Eliminazione di tutti gli eventi per un visitatore specifico in un intervallo di tempo: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
  • Eliminazione degli eventi degli ultimi 30 giorni all'interno di un DataStore: *

Si presume che i campi di filtro abbiano un AND implicito.
force

boolean

Il campo force non è attualmente supportato. Le richieste di eliminazione definitiva degli eventi utente elimineranno definitivamente tutti gli eventi eliminabili. Una volta completato lo sviluppo: se force è impostato su false, il metodo restituirà il numero di eliminazioni previsto senza rimuovere alcun evento utente. Se non incluso nella richiesta, questo campo verrà impostato su false per impostazione predefinita.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Operation.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • discoveryengine.userEvents.purge

Per saperne di più, consulta la documentazione di IAM.