Method: projects.locations.collections.dataStores.userEvents.purge

Elimina de forma permanente todos los eventos de usuario especificados por el filtro proporcionado. En función del número de eventos especificados en el filtro, esta operación puede tardar horas o días en completarse. Para probar un filtro, usa primero el comando de lista.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Nombre de recurso del catálogo en el que se crean los eventos. El formato es projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan la siguiente estructura:

Representación JSON 
{
  "filter": string,
  "force": boolean
}
Campos
filter

string

Obligatorio. Cadena de filtro para especificar los eventos que se van a eliminar. La longitud máxima es de 5000 caracteres. Los campos aptos para filtrar son los siguientes:

  • eventType: cadena UserEvent.event_type entre comillas dobles.
  • eventTime: en formato "zulu" ISO 8601.
  • userPseudoId: cadena entre comillas dobles. Si especifica este valor, se eliminarán todos los eventos asociados a un visitante.
  • userId: cadena entre comillas dobles. Si lo especificas, se eliminarán todos los eventos asociados a un usuario.

Nota: Esta API solo admite purgas de un intervalo máximo de 30 días.

Ejemplos:

  • Eliminar todos los eventos de un periodo: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
  • Eliminar un eventType específico en un intervalo de tiempo: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
  • Eliminar todos los eventos de un visitante específico en un intervalo de tiempo: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
  • Eliminar los eventos de los últimos 30 días de un DataStore: *

Se presupone que los campos de filtrado tienen un AND implícito.
force

boolean

Actualmente, no se admite el campo force. Las solicitudes de purga de eventos de usuario eliminarán de forma permanente todos los eventos que se puedan purgar. Una vez que se haya completado el desarrollo, si force tiene el valor false, el método devolverá el recuento de purga esperado sin eliminar ningún evento de usuario. Si no se incluye en la solicitud, el valor predeterminado de este campo será false.

Cuerpo de la respuesta

Si la solicitud se hace correctamente, en el cuerpo de la respuesta se incluye una instancia de Operation.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso parent:

  • discoveryengine.userEvents.purge

Para obtener más información, consulta la documentación de gestión de identidades y accesos.